Skip to main content

PlanDefinition

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
identifier0..*IdentifierAdditional identifier for the plan definition
version0..1stringBusiness version of the plan definition
name0..1stringName for this plan definition (computer friendly)
title0..1stringName for this plan definition (human friendly)
subtitle0..1stringSubordinate title of the plan definition
type0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
subject[x]0..1CodeableConceptType of individual the plan definition is focused on
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the plan definition
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
purpose0..1markdownWhy this plan definition is defined
usage0..1stringDescribes the clinical usage of the plan
copyright0..1markdownUse and/or publishing restrictions
approvalDate0..1dateWhen the plan definition was approved by publisher
lastReviewDate0..1dateWhen the plan definition was last reviewed
effectivePeriod0..1PeriodWhen the plan definition is expected to be used
topic0..*CodeableConceptE.g. Education, Treatment, Assessment
author0..*ContactDetailWho authored the content
editor0..*ContactDetailWho edited the content
reviewer0..*ContactDetailWho reviewed the content
endorser0..*ContactDetailWho endorsed the content
relatedArtifact0..*RelatedArtifactAdditional documentation, citations
library0..*canonicalLogic used by the plan definition
goal0..*BackboneElementWhat the plan is trying to accomplish
action0..*BackboneElementAction defined by the plan

Search Parameters

NameTypeDescriptionExpression
composed-ofreferenceWhat resource is being referencedPlanDefinition.relatedArtifact
contexttokenA use context assigned to the plan definitionPlanDefinition.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the plan definitionPlanDefinition.useContext.value
context-typetokenA type of use context assigned to the plan definitionPlanDefinition.useContext.code
datedateThe plan definition publication datePlanDefinition.date
definitionreferenceActivity or plan definitions used by plan definitionPlanDefinition.action.definition
depends-onreferenceWhat resource is being referencedPlanDefinition.relatedArtifact
derived-fromreferenceWhat resource is being referencedPlanDefinition.relatedArtifact
descriptionstringThe description of the plan definitionPlanDefinition.description
effectivedateThe time during which the plan definition is intended to be in usePlanDefinition.effectivePeriod
identifiertokenExternal identifier for the plan definitionPlanDefinition.identifier
jurisdictiontokenIntended jurisdiction for the plan definitionPlanDefinition.jurisdiction
namestringComputationally friendly name of the plan definitionPlanDefinition.name
predecessorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact
publisherstringName of the publisher of the plan definitionPlanDefinition.publisher
statustokenThe current status of the plan definitionPlanDefinition.status
successorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact
titlestringThe human-friendly name of the plan definitionPlanDefinition.title
topictokenTopics associated with the modulePlanDefinition.topic
typetokenThe type of artifact the plan (e.g. order-set, eca-rule, protocol)PlanDefinition.type
urluriThe uri that identifies the plan definitionPlanDefinition.url
versiontokenThe business version of the plan definitionPlanDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the plan definitionPlanDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the plan definitionPlanDefinition.useContext