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-treatment-plan | Version: 0.1.0 | |||
Active as of 2024-04-27 | Computable Name: KIOLATreatmentPlan |
Instance of a KIOLA standard treatment plan, that might have been adapted individually for the patient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |
Slices for instantiatesCanonical | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | |
instantiatesCanonical:kiolaStandardTreatmentPlan | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. | |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
reference | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | |
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
Slices for action | S | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() |
action:kiolaMeasurementRequests | S | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. |
resource | S | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for instantiatesCanonical | Σ | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() |
instantiatesCanonical:kiolaStandardTreatmentPlan | Σ | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
reference | ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject |
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
Slices for action | SC | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() rqg-1: Must have resource or action but not both |
action:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
action:kiolaMeasurementRequests | SC | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. rqg-1: Must have resource or action but not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
resource | SC | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | |
RequestGroup.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |||||
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 | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
Slices for instantiatesCanonical | Σ | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | ||||
instantiatesCanonical:kiolaStandardTreatmentPlan | Σ | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | 0..* | Reference(Resource) | Fulfills plan, proposal, or order | |||||
replaces | 0..* | Reference(Resource) | Request(s) replaced by this request | |||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
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..1 | CodeableConcept | What's being requested/ordered | ||||
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 0..1 | Reference(Encounter) | Created as part of | |||||
authoredOn | 0..1 | dateTime | When the request group was authored | |||||
author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group | |||||
reasonCode | 0..* | CodeableConcept | Why the request group is needed | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed | |||||
note | 0..* | Annotation | Additional notes about the response | |||||
Slices for action | SC | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() rqg-1: Must have resource or action but not both | ||||
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 | Short 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 | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
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): The kind of condition for the action. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
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 this is 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..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform 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. | |||||
resource | C | 0..1 | Reference(Resource) | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
action:kiolaMeasurementRequests | SC | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. rqg-1: Must have resource or action but not both | ||||
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 | Short 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 | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
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): The kind of condition for the action. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
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 this is 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..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform 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. | |||||
resource | SC | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RequestGroup.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | ||||
RequestGroup.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0 from the FHIR Standard | ||||
RequestGroup.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
RequestGroup.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
This structure is derived from RequestGroup
Differential View
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |
Slices for instantiatesCanonical | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | |
instantiatesCanonical:kiolaStandardTreatmentPlan | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. | |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
reference | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | |
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
Slices for action | S | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() |
action:kiolaMeasurementRequests | S | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. |
resource | S | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for instantiatesCanonical | Σ | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() |
instantiatesCanonical:kiolaStandardTreatmentPlan | Σ | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
reference | ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject |
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
Slices for action | SC | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() rqg-1: Must have resource or action but not both |
action:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
action:kiolaMeasurementRequests | SC | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. rqg-1: Must have resource or action but not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
resource | SC | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | |
RequestGroup.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | KIOLA treatment plan, eventually adapted for the patient | |||||
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 | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
Slices for instantiatesCanonical | Σ | 1..* | canonical() | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | ||||
instantiatesCanonical:kiolaStandardTreatmentPlan | Σ | 1..1 | canonical(KIOLA Standard Treatment Plan) | Standard treatment plan, this treatment plan is based on. | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | 0..* | Reference(Resource) | Fulfills plan, proposal, or order | |||||
replaces | 0..* | Reference(Resource) | Request(s) replaced by this request | |||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
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..1 | CodeableConcept | What's being requested/ordered | ||||
subject | 0..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
identifier | S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 0..1 | Reference(Encounter) | Created as part of | |||||
authoredOn | 0..1 | dateTime | When the request group was authored | |||||
author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group | |||||
reasonCode | 0..* | CodeableConcept | Why the request group is needed | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed | |||||
note | 0..* | Annotation | Additional notes about the response | |||||
Slices for action | SC | 0..* | BackboneElement | Proposed actions, if any Slice: Unordered, Open by profile:resource.resolve() rqg-1: Must have resource or action but not both | ||||
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 | Short 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 | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
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): The kind of condition for the action. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
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 this is 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..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform 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. | |||||
resource | C | 0..1 | Reference(Resource) | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
action:kiolaMeasurementRequests | SC | 0..* | BackboneElement | Measurement requests, corresponding to the treatment plan definition. rqg-1: Must have resource or action but not both | ||||
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 | Short 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 | |||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
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): The kind of condition for the action. | |||||
expression | 0..1 | Expression | Boolean-valued expression | |||||
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 this is 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..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform 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. | |||||
resource | SC | 1..1 | Reference(KIOLA Measurement Request) {c} | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RequestGroup.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | ||||
RequestGroup.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0 from the FHIR Standard | ||||
RequestGroup.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
RequestGroup.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
RequestGroup.action:kiolaMeasurementRequests.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
This structure is derived from RequestGroup
Other representations of profile: CSV, Excel, Schematron