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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| 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 | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
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 |
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 |
|---|---|---|
composed-of | reference | What resource is being referenced |
context | token | A use context assigned to the plan definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the plan definition |
context-type | token | A type of use context assigned to the plan definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the plan definition |
context-type-value | composite | A use context type and value assigned to the plan definition |
date | date | The plan definition publication date |
definition | reference | Activity or plan definitions used by plan definition |
depends-on | reference | What resource is being referenced |
derived-from | reference | What resource is being referenced |
description | string | The description of the plan definition |
effective | date | The time during which the plan definition is intended to be in use |
identifier | token | External identifier for the plan definition |
jurisdiction | token | Intended jurisdiction for the plan definition |
name | string | Computationally friendly name of the plan definition |
predecessor | reference | What resource is being referenced |
publisher | string | Name of the publisher of the plan definition |
status | token | The current status of the plan definition |
successor | reference | What resource is being referenced |
title | string | The human-friendly name of the plan definition |
topic | token | Topics associated with the module |
type | token | The type of artifact the plan (e.g. order-set, eca-rule, protocol) |
url | uri | The uri that identifies the plan definition |
version | token | The business version of the plan definition |
Reference
Official FHIR R4 spec: PlanDefinition.
Maturity: Trial Use 2 (FMM 2).