Left: | PlanDefinition (http://fhir.hl7.nl/zorgviewer/StructureDefinition/PlanDefinition) |
Right: | PlanDefinition (http://fhir.hl7.nl/zorgviewer/StructureDefinition/PlanDefinition) |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/PlanDefinition | ||
copyright | |||
description | PlanDefinition voor het ondersteunen van filtering op basis van DataRequirements | ||
experimental | |||
fhirVersion | 3.0.2 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#NL | ||
kind | resource | ||
name | PlanDefinition | ||
publisher | RIVO-NN HL7NL | ||
purpose | |||
status | draft | ||
title | PlanDefinition | ||
type | PlanDefinition | ||
url | http://fhir.hl7.nl/zorgviewer/StructureDefinition/PlanDefinition |
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PlanDefinition | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |||||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (extensible): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (extensible): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
url | Σ | 0..1 | uri | Logical URI to reference this plan definition (globally unique) | Σ | 0..1 | uri | Logical URI to reference this plan definition (globally unique) | |||||||||
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | Σ | 0..* | Identifier | Additional identifier for the plan definition | |||||||||
version | Σ | 0..1 | string | Business version of the plan definition | Σ | 0..1 | string | Business version of the plan definition | |||||||||
name | Σ | 0..1 | string | Name for this plan definition (computer friendly) | Σ | 0..1 | string | Name for this plan definition (computer friendly) | |||||||||
title | Σ | 0..1 | string | Name for this plan definition (human friendly) | Σ | 0..1 | string | Name for this plan definition (human friendly) | |||||||||
type | Σ | 0..1 | CodeableConcept | order-set | protocol | eca-rule Binding: ?? (extensible): The type of PlanDefinition | Σ | 0..1 | CodeableConcept | order-set | protocol | eca-rule Binding: ?? (extensible): The type of PlanDefinition | |||||||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of a Value Set or Concept Map. | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of a Value Set or Concept Map. | |||||||||
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage | ?!Σ | 0..1 | boolean | For testing purposes, not real usage | |||||||||
date | Σ | 0..1 | dateTime | Date this was last changed | Σ | 0..1 | dateTime | Date this was last changed | |||||||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | Σ | 0..1 | string | Name of the publisher (organization or individual) | |||||||||
description | Σ | 0..1 | markdown | Natural language description of the plan definition | Σ | 0..1 | markdown | Natural language description of the plan definition | |||||||||
purpose | 0..1 | markdown | Why this plan definition is defined | 0..1 | markdown | Why this plan definition is defined | |||||||||||
usage | 0..1 | string | Describes the clinical usage of the asset | 0..1 | string | Describes the clinical usage of the asset | |||||||||||
approvalDate | 0..1 | date | When the plan definition was approved by publisher | 0..1 | date | When the plan definition was approved by publisher | |||||||||||
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | 0..1 | date | When the plan definition was last reviewed | |||||||||||
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | Σ | 0..1 | Period | When the plan definition is expected to be used | |||||||||
useContext | Σ | 0..* | UsageContext | Context the content is intended to support | Σ | 0..* | UsageContext | Context the content is intended to support | |||||||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use | |||||||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: ?? (example): High-level categorization of the definition, used for searching, sorting, and filtering | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: ?? (example): High-level categorization of the definition, used for searching, sorting, and filtering | |||||||||||
contributor | 0..* | Contributor | A content contributor | 0..* | Contributor | A content contributor | |||||||||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | Σ | 0..* | ContactDetail | Contact details for the publisher | |||||||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | 0..1 | markdown | Use and/or publishing restrictions | |||||||||||
relatedArtifact | S | 1..* | RelatedArtifact | Related artifacts for the asset | S | 1..* | RelatedArtifact | Related artifacts for the asset | |||||||||
library | 0..* | Reference(Library) | Logic used by the plan definition | 0..* | Reference(Library) | Logic used by the plan definition | |||||||||||
goal | 0..* | BackboneElement | What the plan is trying to accomplish | 0..* | BackboneElement | What the plan is trying to accomplish | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: ?? (example): Example codes for grouping goals for filtering or presentation | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: ?? (example): Example codes for grouping goals for filtering or presentation | |||||||||||
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: ?? (example): Describes goals that can be achieved | 1..1 | CodeableConcept | Code or text describing the goal Binding: ?? (example): Describes goals that can be achieved | |||||||||||
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: ?? (preferred): Indicates the level of importance associated with reaching or sustaining a goal | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: ?? (preferred): Indicates the level of importance associated with reaching or sustaining a goal | |||||||||||
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: ?? (example): Identifies the types of events that might trigger the start of a goal | 0..1 | CodeableConcept | When goal pursuit begins Binding: ?? (example): Identifies the types of events that might trigger the start of a goal | |||||||||||
addresses | 0..* | CodeableConcept | What does the goal address Binding: ?? (example): Identifies problems, conditions, issues, or concerns that goals may address | 0..* | CodeableConcept | What does the goal address Binding: ?? (example): Identifies problems, conditions, issues, or concerns that goals may address | |||||||||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | 0..* | RelatedArtifact | Supporting documentation for the goal | |||||||||||
target | 0..* | BackboneElement | Target outcome for the goal | 0..* | BackboneElement | Target outcome for the goal | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: ?? (example): Identifies types of parameters that can be tracked to determine goal achievement | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: ?? (example): Identifies types of parameters that can be tracked to determine goal achievement | |||||||||||
detail[x] | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved | |||||||||||
due | 0..1 | Duration | Reach goal within | 0..1 | Duration | Reach goal within | |||||||||||
action | 0..* | BackboneElement | Action defined by the plan | 0..* | BackboneElement | Action defined by the plan | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
label | 0..1 | string | User-visible label for the action (e.g. 1. or A.) | 0..1 | string | User-visible label for the action (e.g. 1. or A.) | |||||||||||
title | 0..1 | string | User-visible title | 0..1 | string | User-visible title | |||||||||||
description | 0..1 | string | Short description of the action | 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 | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||||||||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||||||||
reason | 0..* | CodeableConcept | Why the action should be performed | 0..* | CodeableConcept | Why the action should be performed | |||||||||||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||||||||
goalId | 0..* | id | What goals this action supports | 0..* | id | What goals this action supports | |||||||||||
triggerDefinition | 0..* | TriggerDefinition | When the action should be triggered | 0..* | TriggerDefinition | When the action should be triggered | |||||||||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | 0..* | BackboneElement | Whether or not the action is applicable | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
kind | 1..1 | code | applicability | start | stop Binding: ?? (required): Defines the kinds of conditions that can appear on actions | 1..1 | code | applicability | start | stop Binding: ?? (required): Defines the kinds of conditions that can appear on actions | |||||||||||
description | 0..1 | string | Natural language description of the condition | 0..1 | string | Natural language description of the condition | |||||||||||
language | 0..1 | string | Language of the expression | 0..1 | string | Language of the expression | |||||||||||
expression | 0..1 | string | Boolean-valued expression | 0..1 | string | Boolean-valued expression | |||||||||||
input | 0..* | DataRequirement | Input data requirements | 0..* | DataRequirement | Input data requirements | |||||||||||
output | S | 1..* | DataRequirement | Output data definition | S | 1..* | DataRequirement | Output data definition | |||||||||
relatedAction | 0..* | BackboneElement | Relationship to another action | 0..* | BackboneElement | Relationship to another action | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
actionId | 1..1 | id | What action is this related to | 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: ?? (required): Defines the types of relationships between actions | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ?? (required): Defines the types of relationships between actions | |||||||||||
offset[x] | 0..1 | Duration, Range | Time offset for the relationship | 0..1 | Duration, Range | Time offset for the relationship | |||||||||||
timing[x] | 0..1 | dateTime, Period, Duration, Range, Timing | When the action should take place | 0..1 | dateTime, Period, Duration, Range, Timing | When the action should take place | |||||||||||
participant | 0..* | BackboneElement | Who should participate in the action | 0..* | BackboneElement | Who should participate in the action | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
type | 1..1 | code | patient | practitioner | related-person Binding: ?? (required): The type of participant for the action | 1..1 | code | patient | practitioner | related-person Binding: ?? (required): The type of participant for the action | |||||||||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ?? (example): Defines roles played by participants for the action | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ?? (example): Defines roles played by participants for the action | |||||||||||
type | 0..1 | Coding | create | update | remove | fire-event Binding: ?? (required): The type of action to be performed | 0..1 | Coding | create | update | remove | fire-event Binding: ?? (required): The type of action to be performed | |||||||||||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ?? (required): Defines organization behavior of a group | 0..1 | code | visual-group | logical-group | sentence-group Binding: ?? (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: ?? (required): Defines selection behavior of a group | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ?? (required): Defines selection behavior of a group | |||||||||||
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ?? (required): Defines requiredness behavior for selecting an action or an action group | 0..1 | code | must | could | must-unless-documented Binding: ?? (required): Defines requiredness behavior for selecting an action or an action group | |||||||||||
precheckBehavior | 0..1 | code | yes | no Binding: ?? (required): Defines selection frequency behavior for an action or group | 0..1 | code | yes | no Binding: ?? (required): Defines selection frequency behavior for an action or group | |||||||||||
cardinalityBehavior | 0..1 | code | single | multiple Binding: ?? (required): Defines behavior for an action or a group for how many times that item may be repeated | 0..1 | code | single | multiple Binding: ?? (required): Defines behavior for an action or a group for how many times that item may be repeated | |||||||||||
definition | 0..1 | Reference(ActivityDefinition | PlanDefinition) | Description of the activity to be performed | 0..1 | Reference(ActivityDefinition | PlanDefinition) | Description of the activity to be performed | |||||||||||
transform | 0..1 | Reference(StructureMap) | Transform to apply the template | 0..1 | Reference(StructureMap) | Transform to apply the template | |||||||||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | 0..* | BackboneElement | Dynamic aspects of the definition | |||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
description | 0..1 | string | Natural language description of the dynamic value | 0..1 | string | Natural language description of the dynamic value | |||||||||||
path | 0..1 | string | The path to the element to be set dynamically | 0..1 | string | The path to the element to be set dynamically | |||||||||||
language | 0..1 | string | Language of the expression | 0..1 | string | Language of the expression | |||||||||||
expression | 0..1 | string | An expression that provides the dynamic value for the customization | 0..1 | string | An expression that provides the dynamic value for the customization | |||||||||||
action | 0..* | See action (PlanDefinition) | A sub-action | 0..* | See action (PlanDefinition) | A sub-action | |||||||||||
Documentation for this format |