FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the PlanDefinition resource.

PlanDefinition
Element IdPlanDefinition
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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

Short DisplayThe definition of a plan for a series of actions, independent of any specific patient or context
Cardinality0..*
TypeMetadataResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
pld-3Warning goalid should reference the id of a goal definition%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4Warning targetId should reference the id of an action%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
PlanDefinition.url
Element IdPlanDefinition.url
Definition

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 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.

Short DisplayCanonical identifier for this plan definition, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the plan definition to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
PlanDefinition.identifier
Element IdPlanDefinition.identifier
Definition

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.

Short DisplayAdditional identifier for the plan definition
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

PlanDefinition.version
Element IdPlanDefinition.version
Definition

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.

Short DisplayBusiness version of the plan definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

PlanDefinition.versionAlgorithm[x]
Element IdPlanDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

PlanDefinition.name
Element IdPlanDefinition.name
Definition

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.

Short DisplayName for this plan definition (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
PlanDefinition.title
Element IdPlanDefinition.title
Definition

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

Short DisplayName for this plan definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

PlanDefinition.subtitle
Element IdPlanDefinition.subtitle
Definition

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

Short DisplaySubordinate title of the plan definition
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.type
Element IdPlanDefinition.type
Definition

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

Short Displayorder-set | clinical-protocol | eca-rule | workflow-definition
Cardinality0..1
Terminology BindingPlan Definition Type (Extensible)
TypeCodeableConcept
Summarytrue
PlanDefinition.status
Element IdPlanDefinition.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

PlanDefinition.experimental
Element IdPlanDefinition.experimental
Definition

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.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

PlanDefinition.subject[x]
Element IdPlanDefinition.subject[x]
Definition

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.

Short DisplayType of individual the plan definition is focused on
Cardinality0..1
Terminology BindingParticipant Resource Types (Extensible)
TypeCodeableConcept|Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)|canonical(EvidenceVariable)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Meaning if MissingPatient
Summaryfalse
Comments

Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

PlanDefinition.date
Element IdPlanDefinition.date
Definition

The date (and optionally time) when the plan definition was last significantly changed. 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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

PlanDefinition.publisher
Element IdPlanDefinition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.

PlanDefinition.contact
Element IdPlanDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

PlanDefinition.description
Element IdPlanDefinition.description
Definition

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

Short DisplayNatural language description of the plan definition
Cardinality0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

PlanDefinition.useContext
Element IdPlanDefinition.useContext
Definition

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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

PlanDefinition.jurisdiction
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdPlanDefinition.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for plan definition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

PlanDefinition.purpose
Element IdPlanDefinition.purpose
Definition

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

Short DisplayWhy this plan definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.

PlanDefinition.usage
Element IdPlanDefinition.usage
Definition

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

Short DisplayDescribes the clinical usage of the plan
Cardinality0..1
Typemarkdown
Summaryfalse
PlanDefinition.copyright
Element IdPlanDefinition.copyright
Definition

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.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

PlanDefinition.copyrightLabel
Element IdPlanDefinition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

PlanDefinition.approvalDate
Element IdPlanDefinition.approvalDate
Definition

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

Short DisplayWhen the plan definition was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

PlanDefinition.lastReviewDate
Element IdPlanDefinition.lastReviewDate
Definition

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

Short DisplayWhen the plan definition was last reviewed by the publisher
Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Summaryfalse
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

PlanDefinition.effectivePeriod
Element IdPlanDefinition.effectivePeriod
Definition

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

Short DisplayWhen the plan definition is expected to be used
Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.

Summarytrue
Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

PlanDefinition.topic
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdPlanDefinition.topic
Definition

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.

Short DisplayE.g. Education, Treatment, Assessment
Cardinality0..*
Terminology BindingDefinition Topic (Example)
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

Summaryfalse
Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

PlanDefinition.author
Element IdPlanDefinition.author
Definition

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

Short DisplayWho authored the content
Cardinality0..*
TypeContactDetail
Summaryfalse
PlanDefinition.editor
Element IdPlanDefinition.editor
Definition

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

Short DisplayWho edited the content
Cardinality0..*
TypeContactDetail
Summaryfalse
PlanDefinition.reviewer
Element IdPlanDefinition.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

Short DisplayWho reviewed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

PlanDefinition.endorser
Element IdPlanDefinition.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

Short DisplayWho endorsed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

PlanDefinition.relatedArtifact
Element IdPlanDefinition.relatedArtifact
Definition

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

Short DisplayAdditional documentation, citations
Cardinality0..*
TypeRelatedArtifact
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Summaryfalse
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

PlanDefinition.library
Element IdPlanDefinition.library
Definition

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

Short DisplayLogic used by the plan definition
Cardinality0..*
Typecanonical(Library)
Summaryfalse
PlanDefinition.goal
Element IdPlanDefinition.goal
Definition

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.

Short DisplayWhat the plan is trying to accomplish
Cardinality0..*
Requirements

Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.

Summaryfalse
Invariants
Affect this element
pld-3Warning goalid should reference the id of a goal definition%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
PlanDefinition.goal.category
Element IdPlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

Short DisplayE.g. Treatment, dietary, behavioral
Cardinality0..1
Terminology BindingGoal Category (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.goal.description
Element IdPlanDefinition.goal.description
Definition

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

Short DisplayCode or text describing the goal
Cardinality1..1
Terminology BindingSNOMED CT Clinical Findings (Example)
TypeCodeableConcept
Summaryfalse
Comments

If no code is available, use CodeableConcept.text.

PlanDefinition.goal.priority
Element IdPlanDefinition.goal.priority
Definition

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

Short Displayhigh-priority | medium-priority | low-priority
Cardinality0..1
Terminology BindingGoal Priority (Preferred)
TypeCodeableConcept
Summaryfalse
PlanDefinition.goal.start
Element IdPlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

Short DisplayWhen goal pursuit begins
Cardinality0..1
Terminology BindingGoal Start Event (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.goal.addresses
Element IdPlanDefinition.goal.addresses
Definition

Identifies problems, conditions, issues, or concerns the goal is intended to address.

Short DisplayWhat does the goal address
Cardinality0..*
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.goal.documentation
Element IdPlanDefinition.goal.documentation
Definition

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

Short DisplaySupporting documentation for the goal
Cardinality0..*
TypeRelatedArtifact
Summaryfalse
PlanDefinition.goal.target
Element IdPlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

Short DisplayTarget outcome for the goal
Cardinality0..*
Summaryfalse
PlanDefinition.goal.target.measure
Element IdPlanDefinition.goal.target.measure
Definition

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Short DisplayThe parameter whose value is to be tracked
Cardinality0..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.goal.target.detail[x]
Element IdPlanDefinition.goal.target.detail[x]
Definition

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

Short DisplayThe target value to be achieved
Cardinality0..1
TypeQuantity|Range|CodeableConcept|string|boolean|integer|Ratio
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

PlanDefinition.goal.target.due
Element IdPlanDefinition.goal.target.due
Definition

Indicates the timeframe after the start of the goal in which the goal should be met.

Short DisplayReach goal within
Cardinality0..1
TypeDuration
Summaryfalse
PlanDefinition.actor
Element IdPlanDefinition.actor
Definition

Actors represent the individuals or groups involved in the execution of the defined set of activities.

Short DisplayActors within the plan
Cardinality0..*
Summaryfalse
PlanDefinition.actor.title
Element IdPlanDefinition.actor.title
Definition

A descriptive label for the actor.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.actor.description
Element IdPlanDefinition.actor.description
Definition

A description of how the actor fits into the overall actions of the plan definition.

Short DisplayDescribes the actor
Cardinality0..1
Typemarkdown
Summaryfalse
PlanDefinition.actor.option
Element IdPlanDefinition.actor.option
Definition

The characteristics of the candidates that could serve as the actor.

Short DisplayWho or what can be this actor
Cardinality1..*
Summaryfalse
PlanDefinition.actor.option.type
Element IdPlanDefinition.actor.option.type
Definition

The type of participant in the action.

Short Displaycareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Cardinality0..1
Terminology BindingAction Participant Type (Required)
Typecode
Summaryfalse
PlanDefinition.actor.option.typeCanonical
Element IdPlanDefinition.actor.option.typeCanonical
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
Typecanonical(CapabilityStatement)
Summaryfalse
PlanDefinition.actor.option.typeReference
Element IdPlanDefinition.actor.option.typeReference
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
TypeReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summaryfalse
Comments

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

PlanDefinition.actor.option.role
Element IdPlanDefinition.actor.option.role
Definition

The role the participant should play in performing the described action.

Short DisplayE.g. Nurse, Surgeon, Parent
Cardinality0..1
Terminology BindingAction Participant Role icon (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.action
Element IdPlanDefinition.action
Definition

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.

Short DisplayAction defined by the plan
Cardinality0..*
Summaryfalse
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Invariants
Affect this element
pld-3Warning goalid should reference the id of a goal definition%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4Warning targetId should reference the id of an action%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
PlanDefinition.action.linkId
Element IdPlanDefinition.action.linkId
Definition

An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

Short DisplayUnique id for the action in the PlanDefinition
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.prefix
Element IdPlanDefinition.action.prefix
Definition

A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

Short DisplayUser-visible prefix for the action (e.g. 1. or A.)
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.title
Element IdPlanDefinition.action.title
Definition

The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.description
Element IdPlanDefinition.action.description
Definition

A brief description of the action used to provide a summary to display to the user.

Short DisplayBrief description of the action
Cardinality0..1
Typemarkdown
Summaryfalse
PlanDefinition.action.textEquivalent
Element IdPlanDefinition.action.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

Short DisplayStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Cardinality0..1
Typemarkdown
Summaryfalse
PlanDefinition.action.priority
Element IdPlanDefinition.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Summaryfalse
PlanDefinition.action.code
Element IdPlanDefinition.action.code
Definition

A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

Short DisplayCode representing the meaning of the action or sub-actions
Cardinality0..1
Terminology BindingAction Code (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.action.reason
Element IdPlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

Short DisplayWhy the action should be performed
Cardinality0..*
Terminology BindingAction Reason Code (Example)
TypeCodeableConcept
Summaryfalse
Comments

This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.

PlanDefinition.action.documentation
Element IdPlanDefinition.action.documentation
Definition

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Short DisplaySupporting documentation for the intended performer of the action
Cardinality0..*
TypeRelatedArtifact
Summaryfalse
PlanDefinition.action.goalId
Element IdPlanDefinition.action.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

Short DisplayWhat goals this action supports
Cardinality0..*
Typeid
Summaryfalse
Invariants
Affect this element
pld-3Warning goalid should reference the id of a goal definition%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
PlanDefinition.action.subject[x]
Element IdPlanDefinition.action.subject[x]
Definition

A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. 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.

Short DisplayType of individual the action is focused on
Cardinality0..1
Terminology BindingParticipant Resource Types (Extensible)
TypeCodeableConcept|Reference(Group)|canonical
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Meaning if MissingPatient
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Summaryfalse
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

PlanDefinition.action.trigger
Element IdPlanDefinition.action.trigger
Definition

A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

Short DisplayWhen the action should be triggered
Cardinality0..*
TypeTriggerDefinition
Summaryfalse
PlanDefinition.action.condition
Element IdPlanDefinition.action.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

Short DisplayWhether or not the action is applicable
Cardinality0..*
Summaryfalse
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

PlanDefinition.action.condition.kind
Element IdPlanDefinition.action.condition.kind
Definition

The kind of condition.

Short Displayapplicability | start | stop
Cardinality1..1
Terminology BindingAction Condition Kind (Required)
Typecode
Summaryfalse
Comments

Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

PlanDefinition.action.condition.expression
Element IdPlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

Short DisplayBoolean-valued expression
Cardinality0..1
TypeExpression
Summaryfalse
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

PlanDefinition.action.input
Element IdPlanDefinition.action.input
Definition

Defines input data requirements for the action.

Short DisplayInput data requirements
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
pld-0Rule Input data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.input.title
Element IdPlanDefinition.action.input.title
Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.input.requirement
Element IdPlanDefinition.action.input.requirement
Definition

Defines the data that is to be provided as input to the action.

Short DisplayWhat data is provided
Cardinality0..1
TypeDataRequirement
Summaryfalse
Invariants
Affect this element
pld-0Rule Input data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.input.relatedData
Element IdPlanDefinition.action.input.relatedData
Definition

Points to an existing input or output element that provides data to this input.

Short DisplayWhat data is provided
Cardinality0..1
Typeid
Summaryfalse
Comments

The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

Invariants
Affect this element
pld-0Rule Input data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.output
Element IdPlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

Short DisplayOutput data definition
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
pld-1Rule Output data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.output.title
Element IdPlanDefinition.action.output.title
Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.output.requirement
Element IdPlanDefinition.action.output.requirement
Definition

Defines the data that results as output from the action.

Short DisplayWhat data is provided
Cardinality0..1
TypeDataRequirement
Summaryfalse
Invariants
Affect this element
pld-1Rule Output data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.output.relatedData
Element IdPlanDefinition.action.output.relatedData
Definition

Points to an existing input or output element that is results as output from the action.

Short DisplayWhat data is provided
Cardinality0..1
Typestring
Summaryfalse
Comments

The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

Invariants
Affect this element
pld-1Rule Output data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
PlanDefinition.action.relatedAction
Element IdPlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Short DisplayRelationship to another action
Cardinality0..*
Summaryfalse
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

Invariants
Affect this element
pld-4Warning targetId should reference the id of an action%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
PlanDefinition.action.relatedAction.targetId
Element IdPlanDefinition.action.relatedAction.targetId
Definition

The element id of the target related action.

Short DisplayWhat action is this related to
Cardinality1..1
Typeid
Summaryfalse
Invariants
Affect this element
pld-4Warning targetId should reference the id of an action%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
PlanDefinition.action.relatedAction.relationship
Element IdPlanDefinition.action.relatedAction.relationship
Definition

The relationship of the start of this action to the related action.

Short Displaybefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Cardinality1..1
Terminology BindingAction Relationship Type (Required)
Typecode
Summaryfalse
PlanDefinition.action.relatedAction.endRelationship
Element IdPlanDefinition.action.relatedAction.endRelationship
Definition

The relationship of the end of this action to the related action.

Short Displaybefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Cardinality0..1
Terminology BindingAction Relationship Type (Required)
Typecode
Summaryfalse
PlanDefinition.action.relatedAction.offset[x]
Element IdPlanDefinition.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Short DisplayTime offset for the relationship
Cardinality0..1
TypeDuration|Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
PlanDefinition.action.timing[x]
Element IdPlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

Short DisplayWhen the action should take place
Cardinality0..1
TypeAge|Duration|Range|Timing
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Allows prompting for activities and detection of missed planned activities.

Summaryfalse
Comments

The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

PlanDefinition.action.location
Element IdPlanDefinition.action.location
Definition

Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

Short DisplayWhere it should happen
Cardinality0..1
TypeCodeableReference(Location)
Requirements

Helps in planning of activity.

Alternate Namesfacility
Summaryfalse
Comments

May reference a specific clinical location or may just identify a type of location.

PlanDefinition.action.participant
Element IdPlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

Short DisplayWho should participate in the action
Cardinality0..*
Summaryfalse
PlanDefinition.action.participant.actorId
Element IdPlanDefinition.action.participant.actorId
Definition

A reference to the id element of the actor who will participate in this action.

Short DisplayWhat actor
Cardinality0..1
Typestring
Summaryfalse
PlanDefinition.action.participant.type
Element IdPlanDefinition.action.participant.type
Definition

The type of participant in the action.

Short Displaycareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Cardinality0..1
Terminology BindingAction Participant Type (Required)
Typecode
Summaryfalse
PlanDefinition.action.participant.typeCanonical
Element IdPlanDefinition.action.participant.typeCanonical
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
Typecanonical(CapabilityStatement)
Summaryfalse
PlanDefinition.action.participant.typeReference
Element IdPlanDefinition.action.participant.typeReference
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
TypeReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summaryfalse
Comments

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

PlanDefinition.action.participant.role
Element IdPlanDefinition.action.participant.role
Definition

The role the participant should play in performing the described action.

Short DisplayE.g. Nurse, Surgeon, Parent
Cardinality0..1
Terminology BindingAction Participant Role icon (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.action.participant.function
Element IdPlanDefinition.action.participant.function
Definition

Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

Short DisplayE.g. Author, Reviewer, Witness, etc
Cardinality0..1
Terminology BindingAction Participant Function (Example)
TypeCodeableConcept
Summaryfalse
PlanDefinition.action.type
Element IdPlanDefinition.action.type
Definition

The type of action to perform (create, update, remove).

Short Displaycreate | update | remove | fire-event
Cardinality0..1
Terminology BindingAction Type (Extensible)
TypeCodeableConcept
Summaryfalse
PlanDefinition.action.groupingBehavior
Element IdPlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Short Displayvisual-group | logical-group | sentence-group
Cardinality0..1
Terminology BindingAction Grouping Behavior (Required)
Typecode
Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
Summaryfalse
PlanDefinition.action.selectionBehavior
Element IdPlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Short Displayany | all | all-or-none | exactly-one | at-most-one | one-or-more
Cardinality0..1
Terminology BindingAction Selection Behavior (Required)
Typecode
Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
Summaryfalse
PlanDefinition.action.requiredBehavior
Element IdPlanDefinition.action.requiredBehavior
Definition

Defines the required behavior for the action.

Short Displaymust | could | must-unless-documented
Cardinality0..1
Terminology BindingAction Required Behavior (Required)
Typecode
Meaning if MissingIf no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
Summaryfalse
PlanDefinition.action.precheckBehavior
Element IdPlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Short Displayyes | no
Cardinality0..1
Terminology BindingAction Precheck Behavior (Required)
Typecode
Meaning if MissingIf no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
Summaryfalse
PlanDefinition.action.cardinalityBehavior
Element IdPlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Short Displaysingle | multiple
Cardinality0..1
Terminology BindingAction Cardinality Behavior (Required)
Typecode
Meaning if MissingIf no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
Summaryfalse
PlanDefinition.action.definition[x]
Element IdPlanDefinition.action.definition[x]
Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

Short DisplayDescription of the activity to be performed
Cardinality0..1
Typecanonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)|uri
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.

PlanDefinition.action.transform
Element IdPlanDefinition.action.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Short DisplayTransform to apply the template
Cardinality0..1
Typecanonical(StructureMap)
Summaryfalse
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

PlanDefinition.action.dynamicValue
Element IdPlanDefinition.action.dynamicValue
Definition

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

Short DisplayDynamic aspects of the definition
Cardinality0..*
Summaryfalse
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

PlanDefinition.action.dynamicValue.path
Element IdPlanDefinition.action.dynamicValue.path
Definition

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

Short DisplayThe path to the element to be set dynamically
Cardinality0..1
Typestring
Summaryfalse
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

PlanDefinition.action.dynamicValue.expression
Element IdPlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Short DisplayAn expression that provides the dynamic value for the customization
Cardinality0..1
TypeExpression
Summaryfalse
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

PlanDefinition.action.action
Element IdPlanDefinition.action.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

Short DisplayA sub-action
Cardinality0..*
TypeSee PlanDefinition.action
Summaryfalse
PlanDefinition.asNeeded[x]
Element IdPlanDefinition.asNeeded[x]
Definition

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

Short DisplayPreconditions for service
Cardinality0..1
Terminology BindingSNOMED CT Medication As Needed Reason Codes (Example)
Typeboolean|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue