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.

Structure

Search Parameters

_id (token)
Logical id of this artifact
Resource.id
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))
_query (token)
A custom search profile that describes a specific defined query operation
derived-from (reference)
What resource is being referenced
PlanDefinition.relatedArtifact.where(type='derived-from').resource
name (string)
Computationally friendly name of the plan definition
PlanDefinition.name
successor (reference)
What resource is being referenced
PlanDefinition.relatedArtifact.where(type='successor').resource
_content (string)
Search on the entire content of the resource
context-type-value (composite)
A use context type and value assigned to the plan definition
PlanDefinition.useContext
title (string)
The human-friendly name of the plan definition
PlanDefinition.title
topic (token)
Topics associated with the module
PlanDefinition.topic
publisher (string)
Name of the publisher of the plan definition
PlanDefinition.publisher
_tag (token)
Tags applied to this resource
Resource.meta.tag
type (token)
The type of artifact the plan %28e.g. order-set, eca-rule, protocol%29
PlanDefinition.type
_type (token)
Derived from the R4B Definition
$this.type().name
_profile (uri)
Profiles this resource claims to conform to
Resource.meta.profile
composed-of (reference)
What resource is being referenced
PlanDefinition.relatedArtifact.where(type='composed-of').resource
url (uri)
The uri that identifies the plan definition
PlanDefinition.url
_lastUpdated (date)
When the resource version last changed
Resource.meta.lastUpdated
definition (reference)
Activity or plan definitions used by plan definition
PlanDefinition.action.definition
context-type-quantity (composite)
A use context type and quantity- or range-based value assigned to the plan definition
PlanDefinition.useContext
identifier (token)
External identifier for the plan definition
PlanDefinition.identifier
version (token)
The business version of the plan definition
PlanDefinition.version
jurisdiction (token)
Intended jurisdiction for the plan definition
PlanDefinition.jurisdiction
status (token)
The current status of the plan definition
PlanDefinition.status
effective (date)
The time during which the plan definition is intended to be in use
PlanDefinition.effectivePeriod
depends-on (reference)
What resource is being referenced
PlanDefinition.relatedArtifact.where(type='depends-on').resource / PlanDefinition.library
context-type (token)
A type of use context assigned to the plan definition
PlanDefinition.useContext.code
description (string)
The description of the plan definition
PlanDefinition.description
predecessor (reference)
What resource is being referenced
PlanDefinition.relatedArtifact.where(type='predecessor').resource
context (token)
A use context assigned to the plan definition
(PlanDefinition.useContext.value.ofType(CodeableConcept))
date (date)
The plan definition publication date
PlanDefinition.date
_text (string)
Search on the narrative of the resource
_haste-health-author (reference)
The author of the resource
Resource.meta.extension.where(url='https://haste.health/author').value
_security (token)
Security Labels applied to this resource
Resource.meta.security
_source (uri)
Identifies where the resource comes from
Resource.meta.source