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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. If the element is present, it must have either a @value, an @id, or extensions

type PlanDefinition implements Resource {
  url: Uri
  identifier: [Identifier]
  version: String
  name: String
  title: String
  subtitle: String
  type: CodeableConcept
  status: String
  experimental: Boolean
  subjectCodeableConcept: CodeableConcept
  subjectReference: Reference
  subjectCanonical: Uri
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  purpose: String
  usage: String
  copyright: String
  approvalDate: Date
  lastReviewDate: Date
  effectivePeriod: Period
  topic: [CodeableConcept]
  author: [ContactDetail]
  editor: [ContactDetail]
  reviewer: [ContactDetail]
  endorser: [ContactDetail]
  relatedArtifact: [RelatedArtifact]
  library: [Uri]
  goal: [PlanDefinitionGoal]
  action: [PlanDefinitionAction]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

PlanDefinition.url ● Uri scalar

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

PlanDefinition.identifier ● [Identifier] list object

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

PlanDefinition.version ● String scalar

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

PlanDefinition.name ● String scalar

A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

PlanDefinition.title ● String scalar

A short, descriptive, user-friendly title for the plan definition.

PlanDefinition.subtitle ● String scalar

An explanatory or alternate title for the plan definition giving additional information about its content.

PlanDefinition.type ● CodeableConcept object

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

PlanDefinition.status ● String scalar

The status of this plan definition. Enables tracking the life-cycle of the content.

PlanDefinition.experimental ● Boolean scalar

A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

PlanDefinition.subjectCodeableConcept ● CodeableConcept object

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

PlanDefinition.subjectReference ● Reference object

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

PlanDefinition.subjectCanonical ● Uri scalar

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

PlanDefinition.date ● Date scalar

The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

PlanDefinition.publisher ● String scalar

The name of the organization or individual that published the plan definition.

PlanDefinition.contact ● [ContactDetail] list object

Contact details to assist a user in finding and communicating with the publisher.

PlanDefinition.description ● String scalar

A free text natural language description of the plan definition from a consumer s perspective.

PlanDefinition.useContext ● [UsageContext] list object

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

PlanDefinition.jurisdiction ● [CodeableConcept] list object

A legal or geographic region in which the plan definition is intended to be used.

PlanDefinition.purpose ● String scalar

Explanation of why this plan definition is needed and why it has been designed as it has.

PlanDefinition.usage ● String scalar

A detailed description of how the plan definition is used from a clinical perspective.

PlanDefinition.copyright ● String scalar

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

PlanDefinition.approvalDate ● Date scalar

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

PlanDefinition.lastReviewDate ● Date scalar

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

PlanDefinition.effectivePeriod ● Period object

The period during which the plan definition content was or is planned to be in active use.

PlanDefinition.topic ● [CodeableConcept] list object

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

PlanDefinition.author ● [ContactDetail] list object

An individiual or organization primarily involved in the creation and maintenance of the content.

PlanDefinition.editor ● [ContactDetail] list object

An individual or organization primarily responsible for internal coherence of the content.

PlanDefinition.reviewer ● [ContactDetail] list object

An individual or organization primarily responsible for review of some aspect of the content.

PlanDefinition.endorser ● [ContactDetail] list object

An individual or organization responsible for officially endorsing the content for use in some setting.

PlanDefinition.relatedArtifact ● [RelatedArtifact] list object

Related artifacts such as additional documentation, justification, or bibliographic references.

PlanDefinition.library ● [Uri] list scalar

A reference to a Library resource containing any formal logic used by the plan definition.

PlanDefinition.goal ● [PlanDefinitionGoal] list object

A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

PlanDefinition.action ● [PlanDefinitionAction] list object

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

PlanDefinition.text ● Narrative object

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

PlanDefinition.contained ● [Resource] list interface

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

PlanDefinition.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

PlanDefinition.modifierExtension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

PlanDefinition.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

PlanDefinition.meta ● Meta object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

PlanDefinition.implicitRules ● Uri scalar

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

PlanDefinition.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

PlanDefinition query ● PlanDefinitionCreate mutation ● PlanDefinitionList query ● PlanDefinitionUpdate mutation