Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlanDefinition

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact

Hierarchy

Index

Properties

Optional action

Action defined by the plan

Optional approvalDate

approvalDate: date

When the plan definition was approved by publisher

Optional author

author: ContactDetail[]

Who authored the content

Optional contact

contact: ContactDetail[]

Contact details for the publisher

Optional contained

contained: Resource[]

Contained, inline Resources

Optional copyright

copyright: markdown

Use and/or publishing restrictions

Optional date

date: dateTime

Date last changed

Optional description

description: markdown

Natural language description of the plan definition

Optional editor

editor: ContactDetail[]

Who edited the content

Optional effectivePeriod

effectivePeriod: Period

When the plan definition is expected to be used

Optional endorser

endorser: ContactDetail[]

Who endorsed the content

Optional experimentai

experimentai: undefined | false | true

For testing purposes, not real usage

Optional extension

extension: Extension[]

Additional Content defined by implementations

Optional goal

What the plan is trying to accomplish

Optional id

id: id

Logical id of this artifact

Optional identifier

identifier: Identifier[]

Additional identifier for the plan definition

Optional implicitRules

implicitRules: uri

A set of rules under which this content was created

Optional jurisdiction

jurisdiction: CodeableConcept[]

Intended jurisdiction for plan definition (if applicable) (http://hl7.org/fhir/R4/valueset-jurisdiction.html)

Optional language

language: code

Language of the resource content

Optional lastReviewDate

lastReviewDate: date

When the plan definition was last reviewed

Optional library

library: canonical[]

Logic used by the plan definition

Optional meta

meta: Meta

Metadata about the resource

Optional modifierExtension

modifierExtension: Extension[]

Extensions that cannot be ignored

Optional name

name: undefined | string

Name for this plan definition (computer friendly)

Optional publisher

publisher: undefined | string

Name of the publisher (organization or individual)

Optional purpose

purpose: markdown

Why this plan definition is defined

Optional relatedArtifact

relatedArtifact: RelatedArtifact[]

Additional documentation, citations

Optional resourceType

resourceType: code

The type of the resource.

Optional reviewer

reviewer: ContactDetail[]

Who reviewed the content

status

draft | active | retired | unknown (http://hl7.org/fhir/R4/valueset-publication-status.html)

Optional subjectCodeableConcept

subjectCodeableConcept: CodeableConcept

Type of individual the plan definition is focused on as CodeableConcept Only one of subjectCodeableConcept or subjectReference are allowed simultaneously

Optional subjectReference

subjectReference: Reference

Type of individual the plan definition is focused on as Reference Only one of subjectCodeableConcept or subjectReference are allowed simultaneously

Optional subtitle

subtitle: undefined | string

Subordinate title of the plan definition

Optional text

text: Narrative

Text summary of the resource, for human interpretation

Optional title

title: undefined | string

Name for this plan definition (human friendly)

Optional topic

E.g. Education, Treatment, Assessment (http://hl7.org/fhir/R4/valueset-definition-topic.html)

Optional type

order-set | clinical-protocol | eca-rule | workflow-definition (http://hl7.org/fhir/R4/valueset-plan-definition-type.html)

Optional url

url: uri

Canonical identifier for this plan definition, represented as a URI (globally unique)

Optional usage

usage: undefined | string

Describes the clinical usage of the plan

Optional useContext

useContext: UsageContext[]

The context that the content is intended to support

Optional version

version: undefined | string

Business version of the plan definition

Generated using TypeDoc