PlanDefinition

Trial Use 2 Specialized — Quality & Testing

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/PlanDefinition

Interaction	Method	Path
Read	GET	/fhir/R4/PlanDefinition/[id]
Vread	GET	/fhir/R4/PlanDefinition/[id]/_history/[vid]
Update	PUT	/fhir/R4/PlanDefinition/[id]
Patch	PATCH	/fhir/R4/PlanDefinition/[id]
Delete	DELETE	/fhir/R4/PlanDefinition/[id]
Create	POST	/fhir/R4/PlanDefinition
Search	GET	/fhir/R4/PlanDefinition
History	GET	/fhir/R4/PlanDefinition/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	0..1	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the plan definition
version	string	0..1	Business version of the plan definition
name	string	0..1	Name for this plan definition (computer friendly)
title	string	0..1	Name for this plan definition (human friendly)
subtitle	string	0..1	Subordinate title of the plan definition
type	CodeableConcept	0..1	order-set | clinical-protocol | eca-rule | workflow-definition
status	code	1..1	draft | active | retired | unknown modifier
experimental	boolean	0..1	For testing purposes, not real usage
subject[x]	CodeableConcept / Reference	0..1	Type of individual the plan definition is focused on
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the plan definition
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for plan definition (if applicable)
purpose	markdown	0..1	Why this plan definition is defined
usage	string	0..1	Describes the clinical usage of the plan
copyright	markdown	0..1	Use and/or publishing restrictions
approvalDate	date	0..1	When the plan definition was approved by publisher
lastReviewDate	date	0..1	When the plan definition was last reviewed
effectivePeriod	Period	0..1	When the plan definition is expected to be used
topic	CodeableConcept	0..*	E.g. Education, Treatment, Assessment
author	ContactDetail	0..*	Who authored the content
editor	ContactDetail	0..*	Who edited the content
reviewer	ContactDetail	0..*	Who reviewed the content
endorser	ContactDetail	0..*	Who endorsed the content
relatedArtifact	RelatedArtifact	0..*	Additional documentation, citations
library	canonical	0..*	Logic used by the plan definition
goal	BackboneElement	0..*	What the plan is trying to accomplish
action	BackboneElement	0..*	Action defined by the plan

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
composed-of	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of
context	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-context
context-quantity	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-context-quantity
context-type	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type
context-type-quantity	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-quantity
context-type-value	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-value
date	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-date
definition	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-definition
depends-on	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on
derived-from	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from
description	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-description
effective	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-effective
identifier	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier
jurisdiction	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-jurisdiction
name	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-name
predecessor	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor
publisher	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher
status	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-status
successor	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-successor
title	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-title
topic	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-topic
type	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-type
url	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-url
version	string	http://hl7.org/fhir/SearchParameter/PlanDefinition-version

Reference

• Official FHIR R4 spec: PlanDefinition
• Maturity: Trial Use 2 (FMM 2).