Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot3 - STU 1 Ballot 3 World

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: SoaPlanDefinition

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition Version: 1.0.0-ballot3
Standards status: Trial-use Maturity Level: 1 Computable Name: SoaPlanDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.103

Profile of PlanDefinition for temporary testing for coordination with M11 use.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... action C 0..* BackboneElement Action defined by the plan
This repeating element order: The order of actions is the sequence in which the actions are to be evaluated and performed. This is true of both the actions in the root as well as child actions of each action.
.... Slices for extension Content/Rules for all slices
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.status Base required PublicationStatus 📍6.0.0-ballot5 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
pld-3 warning PlanDefinition goalid should reference the id of a goal definition %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4 warning PlanDefinition targetId should reference the id of an action %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
... Slices for extension Content/Rules for all slices
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... topic 0..0 E.g. Education, Treatment, Assessment
... action
.... Slices for extension Content/Rules for all slices
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... url ΣC 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the plan definition
... version Σ 0..1 string Business version of the plan definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title Σ 0..1 string Name for this plan definition (human friendly)
... subtitle 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | protocol | eca-rule | workflow-definition | etc.
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing only - never for real usage
... subject[x] 0..1 Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonical canonical(EvidenceVariable)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the plan definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this plan definition is defined
... usage 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact C 0..* RelatedArtifact Additional documentation, citations
Constraints: pld-6, pld-7
... library 0..* canonical(Library) Logic used by the plan definition
... goal C 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal priority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... title 0..1 string User-visible title
.... description 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
..... typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example)
... action C 0..* BackboneElement Action defined by the plan
This repeating element order: The order of actions is the sequence in which the actions are to be evaluated and performed. This is true of both the actions in the root as well as child actions of each action.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title 0..1 string User-visible title
.... description 0..1 markdown Brief description of the action
.... textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeExample (example): Provides examples of actions to be performed.
.... reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCodeExample (example): Provides examples of reasons for actions to be performed.
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goalId C 0..* string What goals this action supports
.... subject[x] 0..1 Type of individual the action is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical(Any)
.... trigger 0..* TriggerDefinition When the action should be triggered
.... condition 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction C 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... targetId C 1..1 string What action is this related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timingRelativeTime RelativeTime
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should participate in the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... actorId 0..1 string What actor
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
..... typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunctionExample (example)
.... type 0..1 CodeableConcept create | update | remove | fire-event | etc.
Binding: ActionType (extensible): The type of action to be performed.
.... applicabilityBehavior 0..1 code all | any
Binding: ActionApplicabilityBehavior (required): Defines applicability behavior of a group.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | Measure | MessageDefinition | ObservationDefinition | OperationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical() Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (PlanDefinition) A sub-action
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.language Base required All Languages 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.type Base extensible PlanDefinitionType 📦1.0.1 THO v7.3
PlanDefinition.status Base required PublicationStatus 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.3
PlanDefinition.goal.​category Base example Goal Category 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal priority 📦1.0.1 THO v7.3
PlanDefinition.goal.​start Base example Goal Start Event 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.actor.​option.type Base required Action Participant Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.actor.​option.role Base example Action Participant Role 📦2.0.0 THO v7.3
PlanDefinition.action.​priority Base required RequestPriority 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​code Base example Action Code Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​reason Base example Action Reason Code Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Participant Resource Types 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​condition.kind Base required Action Condition Kind 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​relatedAction.relationship Base required Action Relationship Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​relatedAction.endRelationship Base required Action Relationship Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​participant.type Base required Action Participant Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​participant.role Base example Action Participant Role 📦2.0.0 THO v7.3
PlanDefinition.action.​participant.function Base example Action Participant Function Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​type Base extensible ActionType 📦1.0.1 THO v7.3
PlanDefinition.action.​applicabilityBehavior Base required Action Applicability Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required Action Grouping Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required Action Selection Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required Action Required Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required Action Precheck Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required Action Cardinality Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍6.0.0-ballot5 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning PlanDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
pld-0 error PlanDefinition.action.input Input data elements must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-1 error PlanDefinition.action.output Output data element must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-3 warning PlanDefinition goalid should reference the id of a goal definition %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4 warning PlanDefinition targetId should reference the id of an action %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
pld-6 warning PlanDefinition.relatedArtifact Dependencies of a PlanDefinition should reference a resource type in ('depends-on' | 'part-of') implies ((resource.exists() xor resourceReference.exists()))
pld-7 warning PlanDefinition.relatedArtifact PlanDefinition should not have components type != 'composed-of'

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... action C 0..* BackboneElement Action defined by the plan
This repeating element order: The order of actions is the sequence in which the actions are to be evaluated and performed. This is true of both the actions in the root as well as child actions of each action.
.... Slices for extension Content/Rules for all slices
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.status Base required PublicationStatus 📍6.0.0-ballot5 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
pld-3 warning PlanDefinition goalid should reference the id of a goal definition %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4 warning PlanDefinition targetId should reference the id of an action %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
... Slices for extension Content/Rules for all slices
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... topic 0..0 E.g. Education, Treatment, Assessment
... action
.... Slices for extension Content/Rules for all slices
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... url ΣC 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the plan definition
... version Σ 0..1 string Business version of the plan definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title Σ 0..1 string Name for this plan definition (human friendly)
... subtitle 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | protocol | eca-rule | workflow-definition | etc.
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing only - never for real usage
... subject[x] 0..1 Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonical canonical(EvidenceVariable)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the plan definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this plan definition is defined
... usage 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact C 0..* RelatedArtifact Additional documentation, citations
Constraints: pld-6, pld-7
... library 0..* canonical(Library) Logic used by the plan definition
... goal C 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal priority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... title 0..1 string User-visible title
.... description 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
..... typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example)
... action C 0..* BackboneElement Action defined by the plan
This repeating element order: The order of actions is the sequence in which the actions are to be evaluated and performed. This is true of both the actions in the root as well as child actions of each action.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title 0..1 string User-visible title
.... description 0..1 markdown Brief description of the action
.... textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeExample (example): Provides examples of actions to be performed.
.... reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCodeExample (example): Provides examples of reasons for actions to be performed.
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goalId C 0..* string What goals this action supports
.... subject[x] 0..1 Type of individual the action is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical(Any)
.... trigger 0..* TriggerDefinition When the action should be triggered
.... condition 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction C 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... targetId C 1..1 string What action is this related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timingRelativeTime RelativeTime
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should participate in the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... actorId 0..1 string What actor
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
..... typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunctionExample (example)
.... type 0..1 CodeableConcept create | update | remove | fire-event | etc.
Binding: ActionType (extensible): The type of action to be performed.
.... applicabilityBehavior 0..1 code all | any
Binding: ActionApplicabilityBehavior (required): Defines applicability behavior of a group.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | Measure | MessageDefinition | ObservationDefinition | OperationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical() Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (PlanDefinition) A sub-action
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.language Base required All Languages 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.type Base extensible PlanDefinitionType 📦1.0.1 THO v7.3
PlanDefinition.status Base required PublicationStatus 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.3
PlanDefinition.goal.​category Base example Goal Category 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal priority 📦1.0.1 THO v7.3
PlanDefinition.goal.​start Base example Goal Start Event 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.actor.​option.type Base required Action Participant Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.actor.​option.role Base example Action Participant Role 📦2.0.0 THO v7.3
PlanDefinition.action.​priority Base required RequestPriority 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​code Base example Action Code Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​reason Base example Action Reason Code Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Participant Resource Types 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​condition.kind Base required Action Condition Kind 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​relatedAction.relationship Base required Action Relationship Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​relatedAction.endRelationship Base required Action Relationship Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​participant.type Base required Action Participant Type 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​participant.role Base example Action Participant Role 📦2.0.0 THO v7.3
PlanDefinition.action.​participant.function Base example Action Participant Function Example 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​type Base extensible ActionType 📦1.0.1 THO v7.3
PlanDefinition.action.​applicabilityBehavior Base required Action Applicability Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required Action Grouping Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required Action Selection Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required Action Required Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required Action Precheck Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required Action Cardinality Behavior 📍6.0.0-ballot5 FHIR Std.
PlanDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍6.0.0-ballot5 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning PlanDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
pld-0 error PlanDefinition.action.input Input data elements must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-1 error PlanDefinition.action.output Output data element must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-3 warning PlanDefinition goalid should reference the id of a goal definition %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
pld-4 warning PlanDefinition targetId should reference the id of an action %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
pld-6 warning PlanDefinition.relatedArtifact Dependencies of a PlanDefinition should reference a resource type in ('depends-on' | 'part-of') implies ((resource.exists() xor resourceReference.exists()))
pld-7 warning PlanDefinition.relatedArtifact PlanDefinition should not have components type != 'composed-of'

 

Other representations of profile: CSV, Excel, Schematron