# PlanDefinition

Canonical page: https://docs.ovok.com/api/fhir/r4/plan-definition

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Canonical identifier for this plan definition, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the plan definition |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the plan definition |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this plan definition (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this plan definition (human friendly) |
| <span id="element-subtitle"></span>`subtitle` | [string](/fhir-elements/primitive/string) | `0..1` | Subordinate title of the plan definition |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | order-set \| clinical-protocol \| eca-rule \| workflow-definition |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-subject-x"></span>`subject[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `0..1` | Type of individual the plan definition is focused on |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the plan definition |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for plan definition (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this plan definition is defined |
| <span id="element-usage"></span>`usage` | [string](/fhir-elements/primitive/string) | `0..1` | Describes the clinical usage of the plan |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the plan definition was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the plan definition was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the plan definition is expected to be used |
| <span id="element-topic"></span>`topic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | E.g. Education, Treatment, Assessment |
| <span id="element-author"></span>`author` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who authored the content |
| <span id="element-editor"></span>`editor` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who edited the content |
| <span id="element-reviewer"></span>`reviewer` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who reviewed the content |
| <span id="element-endorser"></span>`endorser` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who endorsed the content |
| <span id="element-related-artifact"></span>`relatedArtifact` | [RelatedArtifact](/fhir-elements/complex/related-artifact) | `0..*` | Additional documentation, citations |
| <span id="element-library"></span>`library` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Logic used by the plan definition |
| <span id="element-goal"></span>`goal` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | What the plan is trying to accomplish |
| <span id="element-action"></span>`action` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Action defined by the plan |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [PlanDefinition](https://hl7.org/fhir/R4/plandefinition.html).  
Maturity: Trial Use 2 (FMM 2).
