HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health PlanDefinition

Defining URL:http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition
Version:1.1.0
Name:USPublicHealthPlanDefinition
Title:US Public Health PlanDefinition
Status:Active as of 2020-12-16T19:27:50+00:00
Definition:

This profile describes the US Public Health PlanDefinition.

Publisher:HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Shareable PlanDefinition

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 1 element

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... title S1..1stringTitle for this PlanDefinition
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
... date S1..1dateTimeDate the PlanDefinition was published
... publisher 1..1stringName of the agency that published this PlanDefinition
... effectivePeriod S0..1PeriodWhen the PlanDefinition is expected to be used
.... start 1..1dateTimeThe start of the time period when this eRSD goes in effect
... library S0..*canonical(Library)Logic used by the plan definition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SI1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version SΣ1..1stringBusiness version of the PlanDefinition
... name SΣI1..1stringName for this PlanDefinition (computer friendly)
... title SΣ1..1stringTitle for this PlanDefinition
... subtitle 0..1stringSubordinate title of the plan definition
... type SΣ0..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate the PlanDefinition was published
... publisher Σ1..1stringName of the agency that published this PlanDefinition
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the plan definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the PlanDefinition is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI1..1dateTimeThe start of the time period when this eRSD goes in effect
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library S0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the PlanDefinition
... name ΣI1..1stringName for this PlanDefinition (computer friendly)
... type Σ0..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... date Σ1..1dateTimeDate the PlanDefinition was published
... contact Σ0..*ContactDetailContact details for the publisher
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... effectivePeriod Σ0..1PeriodWhen the PlanDefinition is expected to be used
... library 0..*canonical(Library)Logic used by the plan definition

doco Documentation for this format

This structure is derived from Shareable PlanDefinition

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 1 element

Differential View

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... title S1..1stringTitle for this PlanDefinition
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
... date S1..1dateTimeDate the PlanDefinition was published
... publisher 1..1stringName of the agency that published this PlanDefinition
... effectivePeriod S0..1PeriodWhen the PlanDefinition is expected to be used
.... start 1..1dateTimeThe start of the time period when this eRSD goes in effect
... library S0..*canonical(Library)Logic used by the plan definition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SI1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version SΣ1..1stringBusiness version of the PlanDefinition
... name SΣI1..1stringName for this PlanDefinition (computer friendly)
... title SΣ1..1stringTitle for this PlanDefinition
... subtitle 0..1stringSubordinate title of the plan definition
... type SΣ0..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate the PlanDefinition was published
... publisher Σ1..1stringName of the agency that published this PlanDefinition
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the plan definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the PlanDefinition is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI1..1dateTimeThe start of the time period when this eRSD goes in effect
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library S0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
PlanDefinition.typeextensibleFixed Value: workflow-definition("Workflow Definition")
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.topicexampleDefinitionTopic
PlanDefinition.goal.categoryexampleGoalCategory
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
PlanDefinition.goal.prioritypreferredGoalPriority
PlanDefinition.goal.startexampleGoalStartEvent
PlanDefinition.goal.addressesexampleCondition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measureexampleLOINCCodes
PlanDefinition.action.priorityrequiredRequestPriority
PlanDefinition.action.subject[x]extensibleSubjectType
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
PlanDefinition.action.participant.typerequiredActionParticipantType
PlanDefinition.action.participant.roleexampleActionParticipantRole
PlanDefinition.action.typeextensibleActionType
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior

Constraints

IdPathDetailsRequirements
dom-2PlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PlanDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4PlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5PlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PlanDefinitionA resource should have narrative for robust management
: text.`div`.exists()
pdf-0PlanDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1PlanDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.effectivePeriod.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.effectivePeriod.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.effectivePeriod.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.effectivePeriod.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.libraryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.target.measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.detail[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.dueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.textEquivalentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.goalIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.triggerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.condition.kindAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.condition.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.inputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.outputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.relatedAction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.relatedAction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.relatedAction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.relatedAction.actionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.offset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.timing[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participant.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.groupingBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.selectionBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.requiredBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.precheckBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.cardinalityBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.definition[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.transformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValue.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.dynamicValue.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.dynamicValue.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.dynamicValue.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.dynamicValue.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValue.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())