Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: ManaakiNgaTahiPlanDefinition

PlanDefinition template which creates Manaaki Nga Tahi (Care in the Community) CarePlans

Usages:

• Examples for this Profile: COVIDMVPCarePlanTemplate
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition	C	0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
PlanDefinition.identifier	Σ This element is included in summaries.	1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
PlanDefinition.identifier.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
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.subject[x]		0..1	CodeableConcept	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.). Required Pattern: At least the following
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.identifier.​use	Base	required	IdentifierUse	📍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.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from PlanDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.implicitRules		0..0		A set of rules under which this content was created
PlanDefinition.contained		0..0		Contained, inline Resources
PlanDefinition.modifierExtension		0..0		Extension
PlanDefinition.identifier		1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Required Pattern: usual
PlanDefinition.identifier.value		1..1	string	The value that is unique
PlanDefinition.subject[x]		0..1	CodeableConcept	Type of individual the plan definition is focused on Required Pattern: At least the following
PlanDefinition.useContext		0..0		The context that the content is intended to support
PlanDefinition.copyright		0..0		Use and/or publishing restrictions
PlanDefinition.approvalDate		0..0		When the plan definition was approved by publisher
PlanDefinition.relatedArtifact		0..0		Additional documentation, citations
PlanDefinition.library		0..0		Logic used by the plan definition
PlanDefinition.goal
PlanDefinition.goal.extension		0..0		Extension
PlanDefinition.goal.modifierExtension		0..0		Extension
PlanDefinition.goal.documentation		0..0		Supporting documentation for the goal
PlanDefinition.goal.target
PlanDefinition.goal.target.id		0..0		Unique id for inter-element referencing
PlanDefinition.goal.target.extension		0..0		Extension
PlanDefinition.goal.target.modifierExtension		0..0		Extension
PlanDefinition.action
PlanDefinition.action.extension		0..0		Extension
PlanDefinition.action.modifierExtension		0..0		Extension
PlanDefinition.action.code		0..0		Code representing the meaning of the action or sub-actions
PlanDefinition.action.reason		0..0		Why the action should be performed
PlanDefinition.action.documentation		0..0		Supporting documentation for the intended performer of the action
PlanDefinition.action.subject[x]		0..1	CodeableConcept	Type of individual the action is focused on
PlanDefinition.action.trigger		0..0		When the action should be triggered
PlanDefinition.action.condition		0..0		Whether or not the action is applicable
PlanDefinition.action.input		0..0		Input data requirements
PlanDefinition.action.output		0..0		Output data definition
PlanDefinition.action.relatedAction		0..0		Relationship to another action
PlanDefinition.action.timing[x]		0..0		When the action should take place
PlanDefinition.action.participant		0..0		Who should participate in the action
PlanDefinition.action.groupingBehavior		0..0		visual-group | logical-group | sentence-group
PlanDefinition.action.selectionBehavior		0..0		any | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanDefinition.action.definition[x]		0..1	canonical(ActivityDefinition | Questionnaire)	Description of the activity to be performed
PlanDefinition.action.transform		0..0		Transform to apply the template
PlanDefinition.action.dynamicValue		0..0		Dynamic aspects of the definition
PlanDefinition.action.action		0..0		A sub-action
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition	C	0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
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.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose 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.extension		0..*	Extension	Additional content defined by implementations
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.	1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.id		0..1	string	Unique id for inter-element referencing
PlanDefinition.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
PlanDefinition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
PlanDefinition.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
PlanDefinition.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
PlanDefinition.identifier.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
PlanDefinition.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
PlanDefinition.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
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	CodeableConcept	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.). Required Pattern: At least the following
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.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.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.goal		0..*	BackboneElement	What the plan is trying to accomplish
PlanDefinition.goal.id		0..1	string	Unique id for inter-element referencing
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.target		0..*	BackboneElement	Target outcome for the goal
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.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.id		0..1	string	Unique id for inter-element referencing
PlanDefinition.action.prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.action.title		0..1	string	User-visible title
PlanDefinition.action.description		0..1	string	Brief description of the action
PlanDefinition.action.textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.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.action.goalId		0..*	id	What goals this action supports
PlanDefinition.action.subject[x]		0..1	CodeableConcept	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.action.type		0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.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.action.precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.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.action.definition[x]		0..1	canonical(ActivityDefinition | Questionnaire)	Description of the activity to be performed
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PlanDefinition.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
PlanDefinition.identifier.​type	Base	extensible	IdentifierType	📍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.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.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.​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.​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.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from PlanDefinition

Summary

Mandatory: 3 elements
Prohibited: 31 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition	C	0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
PlanDefinition.identifier	Σ This element is included in summaries.	1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
PlanDefinition.identifier.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
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.subject[x]		0..1	CodeableConcept	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.). Required Pattern: At least the following
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.identifier.​use	Base	required	IdentifierUse	📍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.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from PlanDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition		0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context
PlanDefinition.implicitRules		0..0		A set of rules under which this content was created
PlanDefinition.contained		0..0		Contained, inline Resources
PlanDefinition.modifierExtension		0..0		Extension
PlanDefinition.identifier		1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Required Pattern: usual
PlanDefinition.identifier.value		1..1	string	The value that is unique
PlanDefinition.subject[x]		0..1	CodeableConcept	Type of individual the plan definition is focused on Required Pattern: At least the following
PlanDefinition.useContext		0..0		The context that the content is intended to support
PlanDefinition.copyright		0..0		Use and/or publishing restrictions
PlanDefinition.approvalDate		0..0		When the plan definition was approved by publisher
PlanDefinition.relatedArtifact		0..0		Additional documentation, citations
PlanDefinition.library		0..0		Logic used by the plan definition
PlanDefinition.goal
PlanDefinition.goal.extension		0..0		Extension
PlanDefinition.goal.modifierExtension		0..0		Extension
PlanDefinition.goal.documentation		0..0		Supporting documentation for the goal
PlanDefinition.goal.target
PlanDefinition.goal.target.id		0..0		Unique id for inter-element referencing
PlanDefinition.goal.target.extension		0..0		Extension
PlanDefinition.goal.target.modifierExtension		0..0		Extension
PlanDefinition.action
PlanDefinition.action.extension		0..0		Extension
PlanDefinition.action.modifierExtension		0..0		Extension
PlanDefinition.action.code		0..0		Code representing the meaning of the action or sub-actions
PlanDefinition.action.reason		0..0		Why the action should be performed
PlanDefinition.action.documentation		0..0		Supporting documentation for the intended performer of the action
PlanDefinition.action.subject[x]		0..1	CodeableConcept	Type of individual the action is focused on
PlanDefinition.action.trigger		0..0		When the action should be triggered
PlanDefinition.action.condition		0..0		Whether or not the action is applicable
PlanDefinition.action.input		0..0		Input data requirements
PlanDefinition.action.output		0..0		Output data definition
PlanDefinition.action.relatedAction		0..0		Relationship to another action
PlanDefinition.action.timing[x]		0..0		When the action should take place
PlanDefinition.action.participant		0..0		Who should participate in the action
PlanDefinition.action.groupingBehavior		0..0		visual-group | logical-group | sentence-group
PlanDefinition.action.selectionBehavior		0..0		any | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanDefinition.action.definition[x]		0..1	canonical(ActivityDefinition | Questionnaire)	Description of the activity to be performed
PlanDefinition.action.transform		0..0		Transform to apply the template
PlanDefinition.action.dynamicValue		0..0		Dynamic aspects of the definition
PlanDefinition.action.action		0..0		A sub-action
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PlanDefinition	C	0..*	PlanDefinition	The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
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.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose 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.extension		0..*	Extension	Additional content defined by implementations
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.	1..*	Identifier	Additional identifier for the plan definition
PlanDefinition.identifier.id		0..1	string	Unique id for inter-element referencing
PlanDefinition.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
PlanDefinition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
PlanDefinition.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
PlanDefinition.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
PlanDefinition.identifier.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
PlanDefinition.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
PlanDefinition.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
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	CodeableConcept	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.). Required Pattern: At least the following
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.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.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.goal		0..*	BackboneElement	What the plan is trying to accomplish
PlanDefinition.goal.id		0..1	string	Unique id for inter-element referencing
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.target		0..*	BackboneElement	Target outcome for the goal
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.action		0..*	BackboneElement	Action defined by the plan
PlanDefinition.action.id		0..1	string	Unique id for inter-element referencing
PlanDefinition.action.prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.action.title		0..1	string	User-visible title
PlanDefinition.action.description		0..1	string	Brief description of the action
PlanDefinition.action.textEquivalent		0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.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.action.goalId		0..*	id	What goals this action supports
PlanDefinition.action.subject[x]		0..1	CodeableConcept	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.action.type		0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.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.action.precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.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.action.definition[x]		0..1	canonical(ActivityDefinition | Questionnaire)	Description of the activity to be performed
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PlanDefinition.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PlanDefinition.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
PlanDefinition.identifier.​type	Base	extensible	IdentifierType	📍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.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.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.​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.​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.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from PlanDefinition

Summary

Mandatory: 3 elements
Prohibited: 31 elements

Other representations of profile: CSV, Excel, Schematron