PlanDefinition | Medplum
On this page
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.
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| url | uri | Canonical identifier for this plan definition, represented as a URI (globally unique). A globally unique absolute URI to identify this plan definition. | |
| identifier | Identifier[] | Additional identifier for the plan definition. | |
| version | string | Business version of the plan definition. | |
| name | string | Name for this plan definition (computer friendly). | |
| title | string | Name for this plan definition (human friendly). | |
| subtitle | string | Subordinate title of the plan definition. | |
| type | CodeableConcept | order-set | |
| status | ✓ | code | draft |
| experimental | boolean | For testing purposes, not real usage. | |
| subject[x] | CodeableConcept, Reference< Group > | Type of individual the plan definition is focused on. | |
| date | dateTime | Date last changed. | |
| publisher | string | Name of the publisher (organization or individual). | |
| contact | ContactDetail[] | Contact details for the publisher. | |
| description | markdown | Natural language description of the plan definition. | |
| useContext | UsageContext[] | The context that the content is intended to support. | |
| jurisdiction | CodeableConcept[] | Intended jurisdiction for plan definition (if applicable). | |
| purpose | markdown | Why this plan definition is defined. | |
| usage | string | Describes the clinical usage of the plan. | |
| copyright | markdown | Use and/or publishing restrictions. | |
| approvalDate | date | When the plan definition was approved by publisher. | |
| lastReviewDate | date | When the plan definition was last reviewed. | |
| effectivePeriod | Period | When the plan definition is expected to be used. | |
| topic | CodeableConcept[] | E.g. Education, Treatment, Assessment. | |
| author | ContactDetail[] | Who authored the content. | |
| editor | ContactDetail[] | Who edited the content. | |
| reviewer | ContactDetail[] | Who reviewed the content. | |
| endorser | ContactDetail[] | Who endorsed the content. | |
| relatedArtifact | RelatedArtifact[] | Additional documentation, citations. | |
| library | canonical[] | Logic used by the plan definition. | |
| goal | PlanDefinitionGoal[] | What the plan is trying to accomplish. | |
| id | string | Unique id for inter-element referencing. | |
| extension | Extension[] | Additional content defined by implementations. | |
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composed-of | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where((type = 'composed-of')).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 |
| definition | reference | Activity or plan definitions used by plan definition | PlanDefinition.action.definition |
| description | string | The description of the plan definition | PlanDefinition.description |
| effective | date | The time during which the plan definition is intended to be in use | PlanDefinition.effectivePeriod |
| identifier | token | External identifier for the plan definition | PlanDefinition.identifier |
| jurisdiction | token | Intended jurisdiction for the plan definition | PlanDefinition.jurisdiction |
| name | string | Computationally friendly name of the plan definition | PlanDefinition.name |
| publisher | string | Name of the publisher of the plan definition | PlanDefinition.publisher |
| status | token | The current status of the plan definition | PlanDefinition.status |
| title | string | The human-friendly name of the plan definition | PlanDefinition.title |
| topic | token | Topics associated with the module | PlanDefinition.topic |
| url | uri | The uri that identifies the plan definition | PlanDefinition.url |
| version | token | The business version of the plan definition | PlanDefinition.version |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact. | |
| text | Narrative | Text summary of the resource. | |
| extension | Extension[] | Additional content defined by implementations. |
This resource is a definition resource from a FHIR workflow perspective. This plan definition is a pre-defined group of actions to be taken in particular circumstances, often including conditional elements, options, and other decision points.