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 2026-10-27 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:

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.

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.Slices for useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.target
PlanDefinition.goal.target.due
PlanDefinition.goal.target.due.Slices for extension 1..1 Extension Extension
Slice: Unordered, Closed by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.goal.target.due.Slices for extension.extension:iso-8601-duration 1..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].extension 1..1 Extension Extension
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.participant
PlanDefinition.Slices for action.action:All Slices.participant.role
PlanDefinition.Slices for action.action:All Slices.participant.role.coding
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.system 0..0 Identity of the terminology system
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type (extensions allowed)
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.timing[x]
PlanDefinition.Slices for action.action:patientAction.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:patientAction.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:patientAction.participant
PlanDefinition.Slices for action.action:patientAction.participant.type 1..1 code patient | practitioner | related-person | device
Required Pattern: patient (extensions allowed)
PlanDefinition.Slices for action.action:patientAction.participant.role 0..0 E.g. Nurse, Surgeon, Parent
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.timing[x]
PlanDefinition.Slices for action.action:practitionerAction.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:practitionerAction.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:practitionerAction.participant
PlanDefinition.Slices for action.action:practitionerAction.participant.type 1..1 code patient | practitioner | related-person | device
Required Pattern: practitioner (extensions allowed)
PlanDefinition.Slices for action.action:practitionerAction.participant.role
PlanDefinition.Slices for action.action:practitionerAction.participant.role.text 1..1 string Plain text representation of the concept

doco 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
NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PlanDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
PlanDefinition.Slices for useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites This element is included in summaries. 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] This element is included in summaries. 1..1 Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueCodeableConcept CodeableConcept
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueQuantity Quantity
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueRange Range
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.Slices for action This element must be supported. 1..* BackboneElement Action defined by the plan
Slice: Unordered, Open by value:participant.type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.timing[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

doco 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.useContext:fhirViewerInvites.​value[x]:valueQuantity Base example ConformanceUseContext 📍4.0.1 FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueRange 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}')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
PlanDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
PlanDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
PlanDefinition.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
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PlanDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
PlanDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.name This element is included in summaries. C 0..1 string Name for this plan definition (computer friendly)
PlanDefinition.title This element is included in summaries. 0..1 string Name for this plan definition (human friendly)
PlanDefinition.subtitle 0..1 string Subordinate title of the plan definition
PlanDefinition.type This element is included in summaries. 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
PlanDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
PlanDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
PlanDefinition.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.).
PlanDefinition.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.subject[x].subjectReference Reference(Group)
PlanDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
PlanDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
PlanDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites This element is included in summaries. 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] This element is included in summaries. 1..1 Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueCodeableConcept CodeableConcept
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueQuantity Quantity
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueRange Range
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
PlanDefinition.purpose 0..1 markdown Why this plan definition is defined
PlanDefinition.usage 0..1 string Describes the clinical usage of the plan
PlanDefinition.copyright 0..1 markdown Use and/or publishing restrictions
PlanDefinition.approvalDate 0..1 date When the plan definition was approved by publisher
PlanDefinition.lastReviewDate 0..1 date When the plan definition was last reviewed
PlanDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
PlanDefinition.author 0..* ContactDetail Who authored the content
PlanDefinition.editor 0..* ContactDetail Who edited the content
PlanDefinition.reviewer 0..* ContactDetail Who reviewed the content
PlanDefinition.endorser 0..* ContactDetail Who endorsed the content
PlanDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations
PlanDefinition.library 0..* canonical(Library) Logic used by the plan definition
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.extension 0..* Extension Additional content defined by implementations
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.goal.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.
PlanDefinition.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.
PlanDefinition.goal.addresses 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
PlanDefinition.goal.documentation 0..* RelatedArtifact Supporting documentation for the goal
PlanDefinition.goal.target 0..* BackboneElement Target outcome for the goal
PlanDefinition.goal.target.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.extension 0..* Extension Additional content defined by implementations
PlanDefinition.goal.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.target.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.
PlanDefinition.goal.target.detail[x] 0..1 The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity Quantity
PlanDefinition.goal.target.detail[x].detailRange Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept CodeableConcept
PlanDefinition.goal.target.due 0..1 Duration Reach goal within
PlanDefinition.goal.target.due.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.due.Slices for extension 1..1 Extension Extension
Slice: Unordered, Closed by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.goal.target.due.Slices for extension.extension:iso-8601-duration 1..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.goal.target.due.value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
PlanDefinition.goal.target.due.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.goal.target.due.unit This element is included in summaries. 0..1 string Unit representation
PlanDefinition.goal.target.due.system This element is included in summaries. C 0..1 uri System that defines coded unit form
PlanDefinition.goal.target.due.code This element is included in summaries. 0..1 code Coded form of the unit
PlanDefinition.Slices for action This element must be supported. 1..* BackboneElement Action defined by the plan
Slice: Unordered, Open by value:participant.type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:All Slices.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:All Slices.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:All Slices.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:All Slices.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:All Slices.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:All Slices.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:All Slices.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:All Slices.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:All Slices.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.).
PlanDefinition.Slices for action.action:All Slices.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:All Slices.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:All Slices.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:All Slices.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:All Slices.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:All Slices.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:All Slices.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:All Slices.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:All Slices.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:All Slices.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:All Slices.relatedAction.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.
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.timing[x].value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
PlanDefinition.Slices for action.action:All Slices.timing[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.Slices for action.action:All Slices.timing[x].unit This element is included in summaries. 0..1 string Unit representation
PlanDefinition.Slices for action.action:All Slices.timing[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
PlanDefinition.Slices for action.action:All Slices.timing[x].code This element is included in summaries. 0..1 code Coded form of the unit
PlanDefinition.Slices for action.action:All Slices.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:All Slices.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
PlanDefinition.Slices for action.action:All Slices.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:All Slices.participant.role.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.role.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.participant.role.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.display This element is included in summaries. 0..1 string Representation defined by the system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for action.action:All Slices.participant.role.text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:All Slices.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:All Slices.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:All Slices.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.
PlanDefinition.Slices for action.action:All Slices.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:All Slices.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:All Slices.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.
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:All Slices.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:All Slices.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:All Slices.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:All Slices.action.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:All Slices.action.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:All Slices.action.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:All Slices.action.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type (extensions allowed)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:All Slices.action.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:All Slices.action.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:All Slices.action.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:All Slices.action.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.).
PlanDefinition.Slices for action.action:All Slices.action.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:All Slices.action.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:All Slices.action.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:All Slices.action.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:All Slices.action.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:All Slices.action.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:All Slices.action.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:All Slices.action.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:All Slices.action.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.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.
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:All Slices.action.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingAge Age
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingRange Range
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:All Slices.action.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:All Slices.action.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
PlanDefinition.Slices for action.action:All Slices.action.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:All Slices.action.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:All Slices.action.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:All Slices.action.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.
PlanDefinition.Slices for action.action:All Slices.action.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:All Slices.action.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:All Slices.action.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.
PlanDefinition.Slices for action.action:All Slices.action.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:All Slices.action.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:All Slices.action.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:All Slices.action.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:patientAction.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:patientAction.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:patientAction.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:patientAction.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:patientAction.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:patientAction.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:patientAction.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:patientAction.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:patientAction.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.).
PlanDefinition.Slices for action.action:patientAction.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:patientAction.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:patientAction.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:patientAction.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:patientAction.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:patientAction.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:patientAction.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:patientAction.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:patientAction.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:patientAction.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:patientAction.relatedAction.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.
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:patientAction.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types Content/Rules for all Types
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:patientAction.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:patientAction.timing[x].timingAge Age
PlanDefinition.Slices for action.action:patientAction.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:patientAction.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:patientAction.timing[x].timingRange Range
PlanDefinition.Slices for action.action:patientAction.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:patientAction.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:patientAction.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
Required Pattern: patient (extensions allowed)
PlanDefinition.Slices for action.action:patientAction.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:patientAction.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:patientAction.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.
PlanDefinition.Slices for action.action:patientAction.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:patientAction.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:patientAction.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.
PlanDefinition.Slices for action.action:patientAction.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:patientAction.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:patientAction.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:patientAction.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:patientAction.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:patientAction.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:patientAction.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:patientAction.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:practitionerAction.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:practitionerAction.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:practitionerAction.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:practitionerAction.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:practitionerAction.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:practitionerAction.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:practitionerAction.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:practitionerAction.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:practitionerAction.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.).
PlanDefinition.Slices for action.action:practitionerAction.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:practitionerAction.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:practitionerAction.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:practitionerAction.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:practitionerAction.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:practitionerAction.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:practitionerAction.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:practitionerAction.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:practitionerAction.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.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.
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:practitionerAction.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types Content/Rules for all Types
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingAge Age
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingRange Range
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:practitionerAction.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:practitionerAction.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
Required Pattern: practitioner (extensions allowed)
PlanDefinition.Slices for action.action:practitionerAction.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:practitionerAction.participant.role.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.participant.role.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:practitionerAction.participant.role.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:practitionerAction.participant.role.text This element is included in summaries. 1..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:practitionerAction.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:practitionerAction.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:practitionerAction.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.
PlanDefinition.Slices for action.action:practitionerAction.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:practitionerAction.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:practitionerAction.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.
PlanDefinition.Slices for action.action:practitionerAction.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:practitionerAction.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:practitionerAction.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:practitionerAction.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:practitionerAction.action 0..* See action (PlanDefinition) A sub-action

doco 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.useContext:fhirViewerInvites.​value[x]:valueQuantity Base example ConformanceUseContext 📍4.0.1 FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueRange 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(7 nested mandatory elements)
Must-Support: 5 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.Slices for useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.target
PlanDefinition.goal.target.due
PlanDefinition.goal.target.due.Slices for extension 1..1 Extension Extension
Slice: Unordered, Closed by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.goal.target.due.Slices for extension.extension:iso-8601-duration 1..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action This element must be supported. 1..* BackboneElement Action defined by the plan
Slice: Unordered, Open by value:participant.type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].extension 1..1 Extension Extension
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.participant
PlanDefinition.Slices for action.action:All Slices.participant.role
PlanDefinition.Slices for action.action:All Slices.participant.role.coding
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.system 0..0 Identity of the terminology system
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type (extensions allowed)
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.timing[x]
PlanDefinition.Slices for action.action:patientAction.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:patientAction.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:patientAction.participant
PlanDefinition.Slices for action.action:patientAction.participant.type 1..1 code patient | practitioner | related-person | device
Required Pattern: patient (extensions allowed)
PlanDefinition.Slices for action.action:patientAction.participant.role 0..0 E.g. Nurse, Surgeon, Parent
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.timing[x]
PlanDefinition.Slices for action.action:practitionerAction.timing[x].Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:practitionerAction.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:practitionerAction.participant
PlanDefinition.Slices for action.action:practitionerAction.participant.type 1..1 code patient | practitioner | related-person | device
Required Pattern: practitioner (extensions allowed)
PlanDefinition.Slices for action.action:practitionerAction.participant.role
PlanDefinition.Slices for action.action:practitionerAction.participant.role.text 1..1 string Plain text representation of the concept

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PlanDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
PlanDefinition.Slices for useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites This element is included in summaries. 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] This element is included in summaries. 1..1 Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueCodeableConcept CodeableConcept
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueQuantity Quantity
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueRange Range
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.Slices for action This element must be supported. 1..* BackboneElement Action defined by the plan
Slice: Unordered, Open by value:participant.type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.timing[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

doco 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.useContext:fhirViewerInvites.​value[x]:valueQuantity Base example ConformanceUseContext 📍4.0.1 FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueRange 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
PlanDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
PlanDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
PlanDefinition.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
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:information This element must be supported. 0..1 string Information Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/information
PlanDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PlanDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
PlanDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.name This element is included in summaries. C 0..1 string Name for this plan definition (computer friendly)
PlanDefinition.title This element is included in summaries. 0..1 string Name for this plan definition (human friendly)
PlanDefinition.subtitle 0..1 string Subordinate title of the plan definition
PlanDefinition.type This element is included in summaries. 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
PlanDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
PlanDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
PlanDefinition.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.).
PlanDefinition.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.subject[x].subjectReference Reference(Group)
PlanDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
PlanDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
PlanDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites This element is included in summaries. 0..1 UsageContext The context that the content is intended to support
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "program"
}
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] This element is included in summaries. 1..1 Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueCodeableConcept CodeableConcept
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueQuantity Quantity
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueRange Range
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x] Content/Rules for all slices
PlanDefinition.Slices for useContext.useContext:fhirViewerInvites.Slices for value[x].value[x]:valueCodeableConcept This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
      "code" : "fhir-viewer-invite"
    }
  ]
}
PlanDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
PlanDefinition.purpose 0..1 markdown Why this plan definition is defined
PlanDefinition.usage 0..1 string Describes the clinical usage of the plan
PlanDefinition.copyright 0..1 markdown Use and/or publishing restrictions
PlanDefinition.approvalDate 0..1 date When the plan definition was approved by publisher
PlanDefinition.lastReviewDate 0..1 date When the plan definition was last reviewed
PlanDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
PlanDefinition.author 0..* ContactDetail Who authored the content
PlanDefinition.editor 0..* ContactDetail Who edited the content
PlanDefinition.reviewer 0..* ContactDetail Who reviewed the content
PlanDefinition.endorser 0..* ContactDetail Who endorsed the content
PlanDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations
PlanDefinition.library 0..* canonical(Library) Logic used by the plan definition
PlanDefinition.goal This element must be supported. 1..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.extension 0..* Extension Additional content defined by implementations
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.goal.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.
PlanDefinition.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.
PlanDefinition.goal.addresses 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
PlanDefinition.goal.documentation 0..* RelatedArtifact Supporting documentation for the goal
PlanDefinition.goal.target 0..* BackboneElement Target outcome for the goal
PlanDefinition.goal.target.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.extension 0..* Extension Additional content defined by implementations
PlanDefinition.goal.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.goal.target.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.
PlanDefinition.goal.target.detail[x] 0..1 The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity Quantity
PlanDefinition.goal.target.detail[x].detailRange Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept CodeableConcept
PlanDefinition.goal.target.due 0..1 Duration Reach goal within
PlanDefinition.goal.target.due.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.due.Slices for extension 1..1 Extension Extension
Slice: Unordered, Closed by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.goal.target.due.Slices for extension.extension:iso-8601-duration 1..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.goal.target.due.value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
PlanDefinition.goal.target.due.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.goal.target.due.unit This element is included in summaries. 0..1 string Unit representation
PlanDefinition.goal.target.due.system This element is included in summaries. C 0..1 uri System that defines coded unit form
PlanDefinition.goal.target.due.code This element is included in summaries. 0..1 code Coded form of the unit
PlanDefinition.Slices for action This element must be supported. 1..* BackboneElement Action defined by the plan
Slice: Unordered, Open by value:participant.type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices Content/Rules for all slices
PlanDefinition.Slices for action.action:All Slices.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:All Slices.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:All Slices.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:All Slices.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:All Slices.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:All Slices.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:All Slices.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:All Slices.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:All Slices.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:All Slices.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.).
PlanDefinition.Slices for action.action:All Slices.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:All Slices.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:All Slices.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:All Slices.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:All Slices.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:All Slices.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:All Slices.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:All Slices.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:All Slices.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:All Slices.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:All Slices.relatedAction.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.
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:All Slices.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:All Slices.timing[x] 0..1 Duration When the action should take place
PlanDefinition.Slices for action.action:All Slices.timing[x].id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.timing[x].Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:All Slices.timing[x].value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
PlanDefinition.Slices for action.action:All Slices.timing[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
PlanDefinition.Slices for action.action:All Slices.timing[x].unit This element is included in summaries. 0..1 string Unit representation
PlanDefinition.Slices for action.action:All Slices.timing[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
PlanDefinition.Slices for action.action:All Slices.timing[x].code This element is included in summaries. 0..1 code Coded form of the unit
PlanDefinition.Slices for action.action:All Slices.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:All Slices.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
PlanDefinition.Slices for action.action:All Slices.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:All Slices.participant.role.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.role.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.participant.role.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.display This element is included in summaries. 0..1 string Representation defined by the system
PlanDefinition.Slices for action.action:All Slices.participant.role.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for action.action:All Slices.participant.role.text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:All Slices.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:All Slices.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:All Slices.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.
PlanDefinition.Slices for action.action:All Slices.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:All Slices.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:All Slices.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.
PlanDefinition.Slices for action.action:All Slices.definition[x] 0..1 canonical(Questionnaire) Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:All Slices.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:All Slices.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:All Slices.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:All Slices.action 0..* BackboneElement A sub-action
PlanDefinition.Slices for action.action:All Slices.action.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:All Slices.action.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:All Slices.action.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:All Slices.action.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:All Slices.action.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:All Slices.action.Slices for code 1..* CodeableConcept Code representing the meaning of the action or sub-actions
Slice: Unordered, Open by value:coding.system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Plan Definition Action Type Value Set (preferred)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type (extensions allowed)
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for action.action:All Slices.action.Slices for code.code:action-type.text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:All Slices.action.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:All Slices.action.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:All Slices.action.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:All Slices.action.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.).
PlanDefinition.Slices for action.action:All Slices.action.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:All Slices.action.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:All Slices.action.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:All Slices.action.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:All Slices.action.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:All Slices.action.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:All Slices.action.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:All Slices.action.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:All Slices.action.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.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.
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:All Slices.action.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:All Slices.action.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingAge Age
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingRange Range
PlanDefinition.Slices for action.action:All Slices.action.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:All Slices.action.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:All Slices.action.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
PlanDefinition.Slices for action.action:All Slices.action.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:All Slices.action.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:All Slices.action.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:All Slices.action.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.
PlanDefinition.Slices for action.action:All Slices.action.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:All Slices.action.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:All Slices.action.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.
PlanDefinition.Slices for action.action:All Slices.action.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:All Slices.action.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:All Slices.action.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:All Slices.action.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:All Slices.action.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:All Slices.action.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.Slices for action.action:patientAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:patientAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:patientAction.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:patientAction.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:patientAction.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:patientAction.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:patientAction.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:patientAction.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:patientAction.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:patientAction.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:patientAction.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.).
PlanDefinition.Slices for action.action:patientAction.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:patientAction.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:patientAction.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:patientAction.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:patientAction.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:patientAction.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:patientAction.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:patientAction.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:patientAction.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:patientAction.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:patientAction.relatedAction.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.
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:patientAction.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:patientAction.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types Content/Rules for all Types
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:patientAction.timing[x].timing[x]All Types.Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:patientAction.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:patientAction.timing[x].timingAge Age
PlanDefinition.Slices for action.action:patientAction.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:patientAction.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:patientAction.timing[x].timingRange Range
PlanDefinition.Slices for action.action:patientAction.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:patientAction.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:patientAction.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
Required Pattern: patient (extensions allowed)
PlanDefinition.Slices for action.action:patientAction.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:patientAction.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:patientAction.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.
PlanDefinition.Slices for action.action:patientAction.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:patientAction.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:patientAction.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.
PlanDefinition.Slices for action.action:patientAction.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:patientAction.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:patientAction.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:patientAction.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:patientAction.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:patientAction.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:patientAction.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:patientAction.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:patientAction.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:patientAction.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:patientAction.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.Slices for action.action:practitionerAction This element must be supported. 0..* BackboneElement Action defined by the plan
PlanDefinition.Slices for action.action:practitionerAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.Slices for action.action:practitionerAction.title 0..1 string User-visible title
PlanDefinition.Slices for action.action:practitionerAction.description 0..1 string Brief description of the action
PlanDefinition.Slices for action.action:practitionerAction.textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.Slices for action.action:practitionerAction.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.Slices for action.action:practitionerAction.code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
PlanDefinition.Slices for action.action:practitionerAction.reason 0..* CodeableConcept Why the action should be performed
PlanDefinition.Slices for action.action:practitionerAction.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.Slices for action.action:practitionerAction.goalId 0..* id What goals this action supports
PlanDefinition.Slices for action.action:practitionerAction.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.).
PlanDefinition.Slices for action.action:practitionerAction.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for action.action:practitionerAction.subject[x].subjectReference Reference(Group)
PlanDefinition.Slices for action.action:practitionerAction.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.Slices for action.action:practitionerAction.condition 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.Slices for action.action:practitionerAction.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.condition.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.condition.kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
PlanDefinition.Slices for action.action:practitionerAction.condition.expression 0..1 Expression Boolean-valued expression
PlanDefinition.Slices for action.action:practitionerAction.input 0..* DataRequirement Input data requirements
PlanDefinition.Slices for action.action:practitionerAction.output 0..* DataRequirement Output data definition
PlanDefinition.Slices for action.action:practitionerAction.relatedAction 0..* BackboneElement Relationship to another action
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.actionId 1..1 id What action is this related to
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.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.
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x] 0..1 Time offset for the relationship
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x].offsetDuration Duration
PlanDefinition.Slices for action.action:practitionerAction.relatedAction.offset[x].offsetRange Range
PlanDefinition.Slices for action.action:practitionerAction.timing[x] 0..1 When the action should take place
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types Content/Rules for all Types
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension Content/Rules for all slices
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timing[x]All Types.Slices for extension.extension:iso-8601-duration 0..1 string ISO-8601 Duration Extension
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingDateTime dateTime
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingAge Age
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingPeriod Period
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingDuration Duration
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingRange Range
PlanDefinition.Slices for action.action:practitionerAction.timing[x].timingTiming Timing
PlanDefinition.Slices for action.action:practitionerAction.participant 0..* BackboneElement Who should participate in the action
PlanDefinition.Slices for action.action:practitionerAction.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.participant.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.
Required Pattern: practitioner (extensions allowed)
PlanDefinition.Slices for action.action:practitionerAction.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
PlanDefinition.Slices for action.action:practitionerAction.participant.role.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.participant.role.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PlanDefinition.Slices for action.action:practitionerAction.participant.role.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
PlanDefinition.Slices for action.action:practitionerAction.participant.role.text This element is included in summaries. 1..1 string Plain text representation of the concept
PlanDefinition.Slices for action.action:practitionerAction.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.Slices for action.action:practitionerAction.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.Slices for action.action:practitionerAction.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.
PlanDefinition.Slices for action.action:practitionerAction.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.Slices for action.action:practitionerAction.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.Slices for action.action:practitionerAction.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.
PlanDefinition.Slices for action.action:practitionerAction.definition[x] 0..1 Description of the activity to be performed
PlanDefinition.Slices for action.action:practitionerAction.definition[x].definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire)
PlanDefinition.Slices for action.action:practitionerAction.definition[x].definitionUri uri
PlanDefinition.Slices for action.action:practitionerAction.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.extension 0..* Extension Additional content defined by implementations
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.Slices for action.action:practitionerAction.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.Slices for action.action:practitionerAction.action 0..* See action (PlanDefinition) A sub-action

doco 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.useContext:fhirViewerInvites.​value[x]:valueQuantity Base example ConformanceUseContext 📍4.0.1 FHIR Std.
PlanDefinition.useContext:fhirViewerInvites.​value[x]:valueRange 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(7 nested mandatory elements)
Must-Support: 5 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

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.