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
Official URL: https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan | Version: 0.1.0 | |||
Active as of 2024-04-27 | Computable Name: KIOLAStandardTreatmentPlan |
A standard treatment plan for a set of KIOLA activities. It can be applied to patients as a stand-alone plan or in combination with other plans and might be individualized for a single patient, after applying it.
KIOLA Standard Treatment Plans might be used to define general treatment plans for specific conditions. They should be as generic as possible and might be combined with each other. On a single KIOLA instance, it is recommended but not required, that all standard treatment plans might be combined without running into any conflict situations. For more details, see the KIOLA Care Plan page.
Official KIOLA Measurement Definitions should be used when defining a plan instance. They should be referred to by their canonical URLs, for a simple example see here. To specify measurement intervals, the timing item might be used, see here for example. To restrict the allowed measurement devices, the participant item might be used to declare the allowed subset, see here for example. The participants might also be overridden to declare specific properties on a device, see here for example.
Plans might be defined for single KIOLA instances, or managed in a central repository for the usage on multiple KIOLA instances. For each variation of a plan, a unique URL and name should be assigned. All plans that should be available on a KIOLA instance, need to be uploaded to the specifc instance, see here. Only plans in status active
can be applied to patients, all other plans should have the status draft
or revoked
.
One or more standard treatment plans might be used to generate a KIOLA Care Plan. When using the API, only the requested plan will be applied. Using the UI, multiple plans might be applied at once. For each standard treatment plan that should be applied for a patient, a separate treatment plan will be added as action to the KIOLA care plan.
The measurement actions can be defined in a couple of ways (1-3), see the examples for details on when to use which method. When applying a treatment plan to a patient, the resulting treatment plan will have a uniform structure.
In case any conflicts occur, the resulting care plan will have the status draft
, otherwise it will have the status active
and will immediately be applied for the patient. For more details on conflicts and how to resolve them, see here.
Plans might be marked as default using a meta data tag. All active default plans will be preselected, when registering a new patient on a KIOLA instance. For more details on how to mark plans as default plans, see here.
Different versions of the same plan should share the same URL and name, but they might use a different business version. This allows the KIOLA system to keep track of all patients that are treated with an instance of a standard plan. It also allows to upgrade patients to a newer version of the plan. Upgrades have to be triggered manually for each patient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities | |
url | S | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. |
name | S | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. |
status | S | 1..1 | code | draft | active | retired | unknown |
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction |
Slices for timing[x] | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place Slice: Unordered, Open by type:$this | |
timing[x]:measurementInterval | S | 0..1 | Timing | Measurement interval |
repeat | SC | 1..1 | Element | How many times should a measurement be taken per period kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
frequency | S | 1..1 | positiveInt | Measurement should be taken frequency times per period |
period | S | 1..1 | decimal | Measurement should be taken frequency times per period |
periodMax | S | 0..1 | decimal | Grace period |
periodUnit | S | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension |
type | 1..1 | code | patient | practitioner | related-person | device Required Pattern: device | |
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension |
type | 1..1 | code | patient | practitioner | related-person | device Required Pattern: device | |
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:measurementInterval.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | C | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. |
name | SΣC | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |
action:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for timing[x] | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | ||
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
timing[x]:timingTiming | S | 0..1 | Timing | Measurement interval |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
frequency | SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period |
period | SΣ | 1..1 | decimal | Measurement should be taken frequency times per period |
periodMax | SΣ | 0..1 | decimal | Grace period |
periodUnit | SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | C | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | SΣ | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
version | Σ | 0..1 | string | Business version of the plan definition | ||||
name | SΣC | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. | ||||
title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this plan definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the plan | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
author | 0..* | ContactDetail | Who authored the content | |||||
editor | 0..* | ContactDetail | Who edited the content | |||||
reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
library | 0..* | canonical(Library) | Logic used by the plan definition | |||||
goal | 0..* | BackboneElement | What the plan is trying to accomplish | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |||||
target | 0..* | BackboneElement | Target outcome for the goal | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
detail[x] | 0..1 | The target value to be achieved | ||||||
detailQuantity | Quantity | |||||||
detailRange | Range | |||||||
detailCodeableConcept | CodeableConcept | |||||||
due | 0..1 | Duration | Reach goal within | |||||
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |||||
action:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
title | 0..1 | string | User-visible title | |||||
description | 0..1 | string | Brief description of the action | |||||
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
reason | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
goalId | 0..* | id | What goals this action supports | |||||
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(Any) | |||||||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
definition[x] | 0..1 | Description of the activity to be performed | ||||||
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
definitionUri | uri | |||||||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
path | 0..1 | string | The path to the element to be set dynamically | |||||
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
action | 0..* | See action (PlanDefinition) | A sub-action | |||||
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
title | 0..1 | string | User-visible title | |||||
description | 0..1 | string | Brief description of the action | |||||
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
reason | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
goalId | 0..* | id | What goals this action supports | |||||
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(Any) | |||||||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
Slices for timing[x] | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
timing[x]:timingTiming | S | 0..1 | Timing | Measurement interval | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
boundsDuration | Duration | |||||||
boundsRange | Range | |||||||
boundsPeriod | Period | |||||||
count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
duration | Σ | 0..1 | decimal | How long when it happens | ||||
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
frequency | SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
period | SΣ | 1..1 | decimal | Measurement should be taken frequency times per period | ||||
periodMax | SΣ | 0..1 | decimal | Grace period | ||||
periodUnit | SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | Σ | 0..* | time | Time of day for action | ||||
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) | ||||
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) | ||||
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |||||
participant:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |||||
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |||||
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. | ||||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
path | 0..1 | string | The path to the element to be set dynamically | |||||
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
action | 0..* | See action (PlanDefinition) | A sub-action | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PlanDefinition.type | extensible | PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
This structure is derived from PlanDefinition
Differential View
This structure is derived from PlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities | |
url | S | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. |
name | S | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. |
status | S | 1..1 | code | draft | active | retired | unknown |
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction |
Slices for timing[x] | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place Slice: Unordered, Open by type:$this | |
timing[x]:measurementInterval | S | 0..1 | Timing | Measurement interval |
repeat | SC | 1..1 | Element | How many times should a measurement be taken per period kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
frequency | S | 1..1 | positiveInt | Measurement should be taken frequency times per period |
period | S | 1..1 | decimal | Measurement should be taken frequency times per period |
periodMax | S | 0..1 | decimal | Grace period |
periodUnit | S | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension |
type | 1..1 | code | patient | practitioner | related-person | device Required Pattern: device | |
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension |
type | 1..1 | code | patient | practitioner | related-person | device Required Pattern: device | |
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:measurementInterval.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | C | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. |
name | SΣC | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |
action:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for timing[x] | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | ||
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
timing[x]:timingTiming | S | 0..1 | Timing | Measurement interval |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
frequency | SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period |
period | SΣ | 1..1 | decimal | Measurement should be taken frequency times per period |
periodMax | SΣ | 0..1 | decimal | Grace period |
periodUnit | SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | |
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | C | 0..* | PlanDefinition | Standard treatment plan for a set of KIOLA activities cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | SΣ | 1..1 | uri | The URI of this standard plan, used to identify which standard plans a patient is enrolled to. Currently, versioning is not supported. | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
version | Σ | 0..1 | string | Business version of the plan definition | ||||
name | SΣC | 1..1 | string | The name of the standard plan. Corresponds to the name of the KIOLA subject tag, used for e.g. filtering. | ||||
title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this plan definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the plan | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
author | 0..* | ContactDetail | Who authored the content | |||||
editor | 0..* | ContactDetail | Who edited the content | |||||
reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
library | 0..* | canonical(Library) | Logic used by the plan definition | |||||
goal | 0..* | BackboneElement | What the plan is trying to accomplish | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |||||
target | 0..* | BackboneElement | Target outcome for the goal | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
detail[x] | 0..1 | The target value to be achieved | ||||||
detailQuantity | Quantity | |||||||
detailRange | Range | |||||||
detailCodeableConcept | CodeableConcept | |||||||
due | 0..1 | Duration | Reach goal within | |||||
Slices for action | 0..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by profile:definition.resolve() | |||||
action:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
title | 0..1 | string | User-visible title | |||||
description | 0..1 | string | Brief description of the action | |||||
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
reason | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
goalId | 0..* | id | What goals this action supports | |||||
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(Any) | |||||||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
definition[x] | 0..1 | Description of the activity to be performed | ||||||
definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
definitionUri | uri | |||||||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
path | 0..1 | string | The path to the element to be set dynamically | |||||
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
action | 0..* | See action (PlanDefinition) | A sub-action | |||||
action:kiolaMeasurement | S | 0..* | BackboneElement | Measurement activities, that are part of this standard plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
patientInstruction | S | 0..1 | string | Plan Definition Patient Instruction URL: https://fhir.ehealth-systems.at/extensions/PlanDefinition/patientInstruction | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
title | 0..1 | string | User-visible title | |||||
description | 0..1 | string | Brief description of the action | |||||
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
reason | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
goalId | 0..* | id | What goals this action supports | |||||
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
subjectCanonical | canonical(Any) | |||||||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
input | 0..* | DataRequirement | Input data requirements | |||||
output | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
Slices for timing[x] | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
timing[x]:timingTiming | S | 0..1 | Timing | Measurement interval | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
boundsDuration | Duration | |||||||
boundsRange | Range | |||||||
boundsPeriod | Period | |||||||
count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
duration | Σ | 0..1 | decimal | How long when it happens | ||||
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
frequency | SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
period | SΣ | 1..1 | decimal | Measurement should be taken frequency times per period | ||||
periodMax | SΣ | 0..1 | decimal | Grace period | ||||
periodUnit | SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | Σ | 0..* | time | Time of day for action | ||||
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) | ||||
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) | ||||
Slices for participant | 0..* | BackboneElement | If present, the given measurement devices override the allowed measurement devices from the activity definition Slice: Unordered, Open by value:extension('https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition').value.resolve().type | |||||
participant:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
participant:automaticTransmission | S | 0..1 | BackboneElement | Measurements might be transmitted automatically using a device like specified here | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |||||
value[x] | S | 1..1 | Reference(KIOLA Measurement Automatic Transmission Device Definition) | Value of extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
participant:manualEntry | S | 0..1 | BackboneElement | Measurements might be entered manually using a device like specified here | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
participantDeviceDefinition | S | 1..1 | (Complex) | Either refer to the corresponding device definition of the measurement definition, or to an adapted compatible definition. URL: https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.ehealth-systems.at/extensions/ParticipantDeviceDefinition" | |||||
value[x] | S | 1..1 | Reference(KIOLA Measurement Manual Entry Device Definition) | Value of extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. Required Pattern: device | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
definition[x] | S | 1..1 | canonical(KIOLA Measurement Definition) | The definition of the activity. This is the only required element for an action. | ||||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
path | 0..1 | string | The path to the element to be set dynamically | |||||
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
action | 0..* | See action (PlanDefinition) | A sub-action | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PlanDefinition.type | extensible | PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant:automaticTransmission.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.type | required | Pattern: devicehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.participant:manualEntry.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action:kiolaMeasurement.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action:kiolaMeasurement.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
kiola-measurement-interval | error | PlanDefinition.action:kiolaMeasurement.timing[x]:timingTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) |
This structure is derived from PlanDefinition
Other representations of profile: CSV, Excel, Schematron