Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: OHH PlanDefinition

Official URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition | Version: 0.1.0
Active as of 2025-12-03 | Computable Name: OhhPlanDefinition

PlanDefinition describes the actions needed as part of a care path for a patient.

### Scope and Usage

The PlanDefinition is the FHIR representation of the program as created in the Open Health Hub Form Designer. The PlanDefinition contains all the tasks of a program, represented by actions and goals.

Usages:

- Refer to this Profile: Ohh Base Care Plan Profile
- Examples for this Profile: Test_PlanDefinition
- CapabilityStatements using this Profile: OHH FHIR API

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from PlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context
Slices for useContext |  | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites |  | 0..1 | UsageContext | The context that the content is intended to support
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
Slices for value[x] |  | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Slice: Unordered, Open by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
goal | S | 1..* | BackboneElement | What the plan is trying to accomplish
target |  |  |  |
due |  |  |  |
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Closed by value:url
extension:iso-8601-duration |  | 1..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
action:All Slices |  |  |  | Content/Rules for all slices
timing[x] |  | 0..1 | Duration | When the action should take place
extension |  | 1..1 | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
role |  |  |  |
coding |  |  |  |
system |  | 0..0 |  | Identity of the terminology system
definition[x] |  | 0..1 | canonical(Questionnaire) | Description of the activity to be performed
action |  | 0..* | BackboneElement | A sub-action
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
action:patientAction | S | 0..* | BackboneElement | Action defined by the plan
timing[x] |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
type |  | 1..1 | code | patient | practitioner | related-person | device Required Pattern: patient
role |  | 0..0 |  | E.g. Nurse, Surgeon, Parent
action:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
timing[x] |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
type |  | 1..1 | code | patient | practitioner | related-person | device Required Pattern: practitioner
role |  |  |  |
text |  | 1..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
Slices for useContext | Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites | Σ | 0..1 | UsageContext | The context that the content is intended to support
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Slices for value[x] | Σ | 1..1 |  | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueReference |  |  | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
goal | S | 1..* | BackboneElement | What the plan is trying to accomplish
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
timing[x] |  | 0..1 | Duration | When the action should take place
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
definition[x] |  | 0..1 | canonical(Questionnaire) | Description of the activity to be performed
action |  | 0..* | BackboneElement | A sub-action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
action:patientAction | S | 0..* | BackboneElement | Action defined by the plan
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
action:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueCodeableConcept | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​timing[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition
version | Σ | 0..1 | string | Business version of the plan definition
name | Σ C | 0..1 | string | Name for this plan definition (computer friendly)
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 | ?!Σ | 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) |
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
Slices for useContext | Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites | Σ | 0..1 | UsageContext | The context that the content is intended to support
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Slices for value[x] | Σ | 1..1 |  | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueReference |  |  | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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 | S | 1..* | 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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Closed by value:url
extension:iso-8601-duration |  | 1..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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 | Duration | When the action should take place
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
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: ActionParticipantRole (example): Defines roles played by participants for the action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
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 | canonical(Questionnaire) | Description of the activity to be performed
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..* | BackboneElement | A sub-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
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.
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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: ActionParticipantRole (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:patientAction | S | 0..* | BackboneElement | Action defined by the plan
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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
timing[x]All Types |  |  |  | Content/Rules for all Types
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
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. Required Pattern: patient
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:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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
timing[x]All Types |  |  |  | Content/Rules for all Types
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
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. Required Pattern: practitioner
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 1..1 | string | Plain text representation of the concept
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueCodeableConcept | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal category | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal start event | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​target.due.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​timing[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG
PlanDefinition.action.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`

This structure is derived from PlanDefinition

Summary

Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

- https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of PlanDefinition.useContext
- The element 1 is sliced based on the value of PlanDefinition.useContext.value[x]
- The element 1 is sliced based on the value of PlanDefinition.action
- The element 1 is sliced based on the value of PlanDefinition.action.action.code

Differential View

This structure is derived from PlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context
Slices for useContext |  | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites |  | 0..1 | UsageContext | The context that the content is intended to support
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
Slices for value[x] |  | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Slice: Unordered, Open by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
goal | S | 1..* | BackboneElement | What the plan is trying to accomplish
target |  |  |  |
due |  |  |  |
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Closed by value:url
extension:iso-8601-duration |  | 1..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
action:All Slices |  |  |  | Content/Rules for all slices
timing[x] |  | 0..1 | Duration | When the action should take place
extension |  | 1..1 | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
role |  |  |  |
coding |  |  |  |
system |  | 0..0 |  | Identity of the terminology system
definition[x] |  | 0..1 | canonical(Questionnaire) | Description of the activity to be performed
action |  | 0..* | BackboneElement | A sub-action
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
action:patientAction | S | 0..* | BackboneElement | Action defined by the plan
timing[x] |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
type |  | 1..1 | code | patient | practitioner | related-person | device Required Pattern: patient
role |  | 0..0 |  | E.g. Nurse, Surgeon, Parent
action:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
timing[x] |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
participant |  |  |  |
type |  | 1..1 | code | patient | practitioner | related-person | device Required Pattern: practitioner
role |  |  |  |
text |  | 1..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
Slices for useContext | Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites | Σ | 0..1 | UsageContext | The context that the content is intended to support
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Slices for value[x] | Σ | 1..1 |  | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueReference |  |  | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
goal | S | 1..* | BackboneElement | What the plan is trying to accomplish
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
action:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
timing[x] |  | 0..1 | Duration | When the action should take place
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
definition[x] |  | 0..1 | canonical(Questionnaire) | Description of the activity to be performed
action |  | 0..* | BackboneElement | A sub-action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
action:patientAction | S | 0..* | BackboneElement | Action defined by the plan
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
action:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueCodeableConcept | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​timing[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition
version | Σ | 0..1 | string | Business version of the plan definition
name | Σ C | 0..1 | string | Name for this plan definition (computer friendly)
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 | ?!Σ | 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) |
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
Slices for useContext | Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code
useContext:fhirViewerInvites | Σ | 0..1 | UsageContext | The context that the content is intended to support
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Slices for value[x] | Σ | 1..1 |  | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueReference |  |  | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fhir-viewer-invite
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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 | S | 1..* | 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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Closed by value:url
extension:iso-8601-duration |  | 1..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
Slices for action | S | 1..* | BackboneElement | Action defined by the plan Slice: Unordered, Open by value:participant.type
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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 | Duration | When the action should take place
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..1 | Extension | Extension Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
value | Σ | 0..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
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: ActionParticipantRole (example): Defines roles played by participants for the action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
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 | canonical(Questionnaire) | Description of the activity to be performed
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..* | BackboneElement | A sub-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
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.
Slices for code |  | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Slice: Unordered, Open by value:coding.system
code:action-type |  | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Plan Definition Action Type Value Set (preferred)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
code:notification |  | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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: ActionParticipantRole (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:patientAction | S | 0..* | BackboneElement | Action defined by the plan
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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
timing[x]All Types |  |  |  | Content/Rules for all Types
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
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. Required Pattern: patient
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:practitionerAction | S | 0..* | BackboneElement | Action defined by the plan
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
reason |  | 0..* | CodeableConcept | Why the action should 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) |
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
timing[x]All Types |  |  |  | Content/Rules for all Types
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:iso-8601-duration |  | 0..1 | string | ISO-8601 Duration Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
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. Required Pattern: practitioner
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 1..1 | string | Plain text representation of the concept
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std.
PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueCodeableConcept | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal category | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal start event | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std.
PlanDefinition.goal.​target.due.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​timing[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.code:action-type | Base | preferred | Plan Definition Action Type Value Set | 📦0.1.0 | This IG
PlanDefinition.action.​action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.relatedAction.​relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action.​action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:patientAction.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
PlanDefinition.action:practitionerAction.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`

This structure is derived from PlanDefinition

Summary

Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

- https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of PlanDefinition.useContext
- The element 1 is sliced based on the value of PlanDefinition.useContext.value[x]
- The element 1 is sliced based on the value of PlanDefinition.action
- The element 1 is sliced based on the value of PlanDefinition.action.action.code

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Retrieving versioned PlanDefinitions

Programs and therefore PlanDefinitions are versioned. If you retrieve the PlanDefinition by id, you’ll get the latest version. You can also request a specific version. It is possible that some patients use an old version, where new patients are on the latest version of the PlanDefinition. When referencing the PlanDefinition in the CarePlan, we therefore reference a specific version of the PlanDefinition. See Handling versioned resources for more info on retrieving versioned resources.