PlanDefinition

ResourceSpecialized · Definitional ArtifactsTrial useMaturity 2

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

22 of 24 parameters tested

Structure

Show inherited elements (29)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifierΣ	0..*	Identifier	Additional identifier for the plan definition
versionΣ	0..1	string	Business version of the plan definition
nameΣ	0..1	string	Name for this plan definition (computer friendly)
titleΣ	0..1	string	Name for this plan definition (human friendly)
subtitle	0..1	string	Subordinate title of the plan definition
typeΣ	0..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definitionBinding (extensible): plan-definition-type
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
subject[x]	0..1	CodeableConcept | Reference(Group)	Type of individual the plan definition is focused onBinding (extensible): subject-type
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
descriptionΣ	0..1	markdown	Natural language description of the plan definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this plan definition is defined
usage	0..1	string	Describes the clinical usage of the plan
copyright	0..1	markdown	Use and/or publishing restrictions
approvalDate	0..1	date	When the plan definition was approved by publisher
lastReviewDate	0..1	date	When the plan definition was last reviewed
effectivePeriodΣ	0..1	Period	When the plan definition is expected to be used
topic	0..*	CodeableConcept	E.g. Education, Treatment, AssessmentBinding (example): definition-topic
author	0..*	ContactDetail	Who authored the content
editor	0..*	ContactDetail	Who edited the content
reviewer	0..*	ContactDetail	Who reviewed the content
endorser	0..*	ContactDetail	Who endorsed the content
relatedArtifact	0..*	RelatedArtifact	Additional documentation, citations
library	0..*	canonical(Library)	Logic used by the plan definition
goal	0..*	BackboneElement	What the plan is trying to accomplish
category	0..1	CodeableConcept	E.g. Treatment, dietary, behavioralBinding (example): goal-category
descriptionRequired	1..1	CodeableConcept	Code or text describing the goalBinding (example): clinical-findings
priority	0..1	CodeableConcept	high-priority | medium-priority | low-priorityBinding (preferred): goal-priority
start	0..1	CodeableConcept	When goal pursuit beginsBinding (example): goal-start-event
addresses	0..*	CodeableConcept	What does the goal addressBinding (example): condition-code
documentation	0..*	RelatedArtifact	Supporting documentation for the goal
target	0..*	BackboneElement	Target outcome for the goal
measure	0..1	CodeableConcept	The parameter whose value is to be trackedBinding (example): observation-codes
detail[x]	0..1	Quantity | Range | CodeableConcept	The target value to be achieved
due	0..1	Duration	Reach goal within
action	0..*	BackboneElement	Action defined by the plan
prefix	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	0..1	string	User-visible title
description	0..1	string	Brief description of the action
textEquivalent	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority	0..1	code	routine | urgent | asap | statBinding (required): request-priority
code	0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
reason	0..*	CodeableConcept	Why the action should be performed
documentation	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goalId	0..*	id	What goals this action supports
subject[x]	0..1	CodeableConcept | Reference(Group)	Type of individual the action is focused onBinding (extensible): subject-type
trigger	0..*	TriggerDefinition	When the action should be triggered
condition	0..*	BackboneElement	Whether or not the action is applicable
kindRequired	1..1	code	applicability | start | stopBinding (required): action-condition-kind
expression	0..1	Expression	Boolean-valued expression
input	0..*	DataRequirement	Input data requirements
output	0..*	DataRequirement	Output data definition
relatedAction	0..*	BackboneElement	Relationship to another action
actionIdRequired	1..1	id	What action is this related to
relationshipRequired	1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endBinding (required): action-relationship-type
offset[x]	0..1	Duration | Range	Time offset for the relationship
timing[x]	0..1	dateTime | Age | Period | Duration | Range | Timing	When the action should take place
participant	0..*	BackboneElement	Who should participate in the action
typeRequired	1..1	code	patient | practitioner | related-person | deviceBinding (required): action-participant-type
role	0..1	CodeableConcept	E.g. Nurse, Surgeon, ParentBinding (example): action-participant-role
type	0..1	CodeableConcept	create | update | remove | fire-eventBinding (extensible): action-type
groupingBehavior	0..1	code	visual-group | logical-group | sentence-groupBinding (required): action-grouping-behavior
selectionBehavior	0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-moreBinding (required): action-selection-behavior
requiredBehavior	0..1	code	must | could | must-unless-documentedBinding (required): action-required-behavior
precheckBehavior	0..1	code	yes | noBinding (required): action-precheck-behavior
cardinalityBehavior	0..1	code	single | multipleBinding (required): action-cardinality-behavior
definition[x]	0..1	canonical(ActivityDefinition | PlanDefinition | Questionnaire) | uri	Description of the activity to be performed
transform	0..1	canonical(StructureMap)	Transform to apply the template
dynamicValue	0..*	BackboneElement	Dynamic aspects of the definition
path	0..1	string	The path to the element to be set dynamically
expression	0..1	Expression	An expression that provides the dynamic value for the customization
action	0..*	Same as PlanDefinition.action	A sub-action

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/PlanDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
composed-of	reference	What resource is being referenced PlanDefinition.relatedArtifact.where(type='composed-of').resource
context	token	A use context assigned to the plan definition (PlanDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the plan definition (PlanDefinition.useContext.value.ofType(Quantity)) | (PlanDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the plan definition PlanDefinition.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the plan definition PlanDefinition.useContext
context-type-value	composite	A use context type and value assigned to the plan definition PlanDefinition.useContext
date	date	The plan definition publication date PlanDefinition.date
definition	reference	Activity or plan definitions used by plan definition PlanDefinition.action.definition
depends-on	reference	What resource is being referenced PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
derived-from	reference	What resource is being referenced PlanDefinition.relatedArtifact.where(type='derived-from').resource
description	string	The description of the plan definition PlanDefinition.description
effective	date	The time during which the plan definition is intended to be in use PlanDefinition.effectivePeriod
identifier	token	External identifier for the plan definition PlanDefinition.identifier
jurisdiction	token	Intended jurisdiction for the plan definition PlanDefinition.jurisdiction
name	string	Computationally friendly name of the plan definition PlanDefinition.name
predecessor	reference	What resource is being referenced PlanDefinition.relatedArtifact.where(type='predecessor').resource
publisher	string	Name of the publisher of the plan definition PlanDefinition.publisher
status	token	The current status of the plan definition PlanDefinition.status
successor	reference	What resource is being referenced PlanDefinition.relatedArtifact.where(type='successor').resource
title	string	The human-friendly name of the plan definition PlanDefinition.title
topic	token	Topics associated with the module PlanDefinition.topic
type	token	The type of artifact the plan (e.g. order-set, eca-rule, protocol) PlanDefinition.type
url	uri	The uri that identifies the plan definition PlanDefinition.url
version	token	The business version of the plan definition PlanDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition