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

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) 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:2.0.0
Name:USPublicHealthPlanDefinition
Title:US Public Health PlanDefinition
Status:Active as of 1/18/22 12:57 PM
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: 5 elements (7 nested mandatory elements)
Must-Support: 28 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... us-ph-receiver-address-extension S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... type S1..1CodeableConceptType of this PlanDefinition
Fixed Value: As shown
.... 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
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the plan definition is focused on
... date S1..1dateTimeDate the PlanDefinition was last changed
... publisher S1..1stringName of the agency that published this PlanDefinition
... effectivePeriod S0..1PeriodWhen the PlanDefinition is valid
.... start 1..1dateTimeThe start of the time period when this PlanDefinition goes into effect
... library S0..*canonical(Library)Logic used by the plan definition
... action S0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... description S0..1stringBrief description of the action
.... code S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition

.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... us-ph-named-eventtype-extension S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

..... type S1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
.... condition S0..*BackboneElementWhether or not the action is applicable
..... kind S1..1codeapplicability | start | stop
..... expression S0..1ExpressionBoolean-valued expression
.... input S0..*DataRequirementInput data requirements
..... type S1..1codeThe type of the required data
.... output S0..*DataRequirementOutput data definition
..... type S1..1codeThe type of the required data
.... relatedAction S0..*BackboneElementRelationship to another action
..... actionId S1..1idWhat action is this related to
..... relationship S1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
..... offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I1..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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-ph-receiver-address-extension S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension
... 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Σ1..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] S0..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 last changed
... publisher SΣ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 valid
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI1..1dateTimeThe start of the time period when this PlanDefinition goes into 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 S0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... 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 S0..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 S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition


.... 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 S0..*TriggerDefinitionWhen the action should be triggered
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... us-ph-named-eventtype-extension S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents


..... type SΣ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (required): The type of trigger.


Fixed Value: named-event
..... name Σ0..1stringName or URI that identifies the event
..... timing[x] Σ0..1Timing of the event
...... timingTimingTiming
...... timingReferenceReference(Schedule)
...... timingDatedate
...... timingDateTimedateTime
..... data Σ0..*DataRequirementTriggering data of the event (multiple = 'and')
..... condition Σ0..1ExpressionWhether the event triggers (boolean expression)
.... condition S0..*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 S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression S0..1ExpressionBoolean-valued expression
.... input S0..*DataRequirementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

..... profile Σ0..*canonical(StructureDefinition)The profile of the required data
..... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

...... subjectCodeableConceptCodeableConcept
...... subjectReferenceReference(Group)
..... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
..... codeFilter ΣI0..*ElementWhat codes are expected
drq-1: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA code-valued attribute to filter on
...... searchParam Σ0..1stringA coded (token) parameter to search on
...... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
...... code Σ0..*CodingWhat code is expected
..... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
drq-2: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA date-valued attribute to filter on
...... searchParam Σ0..1stringA date valued parameter to search on
...... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
....... valueDateTimedateTime
....... valuePeriodPeriod
....... valueDurationDuration
..... limit Σ0..1positiveIntNumber of results
..... sort Σ0..*ElementOrder of the results
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ1..1stringThe name of the attribute to perform the sort
...... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

.... output S0..*DataRequirementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

..... profile Σ0..*canonical(StructureDefinition)The profile of the required data
..... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

...... subjectCodeableConceptCodeableConcept
...... subjectReferenceReference(Group)
..... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
..... codeFilter ΣI0..*ElementWhat codes are expected
drq-1: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA code-valued attribute to filter on
...... searchParam Σ0..1stringA coded (token) parameter to search on
...... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
...... code Σ0..*CodingWhat code is expected
..... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
drq-2: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA date-valued attribute to filter on
...... searchParam Σ0..1stringA date valued parameter to search on
...... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
....... valueDateTimedateTime
....... valuePeriodPeriod
....... valueDurationDuration
..... limit Σ0..1positiveIntNumber of results
..... sort Σ0..*ElementOrder of the results
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ1..1stringThe name of the attribute to perform the sort
...... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

.... relatedAction S0..*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 S1..1idWhat action is this related to
..... relationship S1..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.

..... Slices for offset[x] 0..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place
.... 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
... us-ph-receiver-address-extension 0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the PlanDefinition
... title Σ1..1stringTitle for this PlanDefinition
... type Σ1..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
... 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 Σ1..1dateTimeDate the PlanDefinition was last changed
... publisher Σ1..1stringName of the agency that published this PlanDefinition
... 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 valid
... library 0..*canonical(Library)Logic used by the plan definition
... action 0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... description 0..1stringBrief description of the action
.... code 0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition


.... trigger 0..*TriggerDefinitionWhen the action should be triggered
..... us-ph-named-eventtype-extension 0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents


..... type Σ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (required): The type of trigger.


Fixed Value: named-event
.... condition 0..*BackboneElementWhether or not the action is applicable
..... 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
..... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... output 0..*DataRequirementOutput data definition
..... type Σ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

.... relatedAction 0..*BackboneElementRelationship to another action
..... 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]:offsetDuration 0..1DurationTime offset for the relationship
.... timing[x] 0..1DurationWhen the action should take place

doco Documentation for this format

This structure is derived from Shareable PlanDefinition

Summary

Mandatory: 5 elements (7 nested mandatory elements)
Must-Support: 28 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1Shareable PlanDefinitionUS Public Health PlanDefinition
... us-ph-receiver-address-extension S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... type S1..1CodeableConceptType of this PlanDefinition
Fixed Value: As shown
.... 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
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the plan definition is focused on
... date S1..1dateTimeDate the PlanDefinition was last changed
... publisher S1..1stringName of the agency that published this PlanDefinition
... effectivePeriod S0..1PeriodWhen the PlanDefinition is valid
.... start 1..1dateTimeThe start of the time period when this PlanDefinition goes into effect
... library S0..*canonical(Library)Logic used by the plan definition
... action S0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... description S0..1stringBrief description of the action
.... code S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition

.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... us-ph-named-eventtype-extension S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

..... type S1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
.... condition S0..*BackboneElementWhether or not the action is applicable
..... kind S1..1codeapplicability | start | stop
..... expression S0..1ExpressionBoolean-valued expression
.... input S0..*DataRequirementInput data requirements
..... type S1..1codeThe type of the required data
.... output S0..*DataRequirementOutput data definition
..... type S1..1codeThe type of the required data
.... relatedAction S0..*BackboneElementRelationship to another action
..... actionId S1..1idWhat action is this related to
..... relationship S1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
..... offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I1..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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-ph-receiver-address-extension S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension
... 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Σ1..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] S0..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 last changed
... publisher SΣ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 valid
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI1..1dateTimeThe start of the time period when this PlanDefinition goes into 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 S0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... 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 S0..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 S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition


.... 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 S0..*TriggerDefinitionWhen the action should be triggered
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... us-ph-named-eventtype-extension S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents


..... type SΣ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (required): The type of trigger.


Fixed Value: named-event
..... name Σ0..1stringName or URI that identifies the event
..... timing[x] Σ0..1Timing of the event
...... timingTimingTiming
...... timingReferenceReference(Schedule)
...... timingDatedate
...... timingDateTimedateTime
..... data Σ0..*DataRequirementTriggering data of the event (multiple = 'and')
..... condition Σ0..1ExpressionWhether the event triggers (boolean expression)
.... condition S0..*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 S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression S0..1ExpressionBoolean-valued expression
.... input S0..*DataRequirementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

..... profile Σ0..*canonical(StructureDefinition)The profile of the required data
..... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

...... subjectCodeableConceptCodeableConcept
...... subjectReferenceReference(Group)
..... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
..... codeFilter ΣI0..*ElementWhat codes are expected
drq-1: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA code-valued attribute to filter on
...... searchParam Σ0..1stringA coded (token) parameter to search on
...... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
...... code Σ0..*CodingWhat code is expected
..... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
drq-2: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA date-valued attribute to filter on
...... searchParam Σ0..1stringA date valued parameter to search on
...... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
....... valueDateTimedateTime
....... valuePeriodPeriod
....... valueDurationDuration
..... limit Σ0..1positiveIntNumber of results
..... sort Σ0..*ElementOrder of the results
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ1..1stringThe name of the attribute to perform the sort
...... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

.... output S0..*DataRequirementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codeThe type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

..... profile Σ0..*canonical(StructureDefinition)The profile of the required data
..... subject[x] Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

...... subjectCodeableConceptCodeableConcept
...... subjectReferenceReference(Group)
..... mustSupport Σ0..*stringIndicates specific structure elements that are referenced by the knowledge module
..... codeFilter ΣI0..*ElementWhat codes are expected
drq-1: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA code-valued attribute to filter on
...... searchParam Σ0..1stringA coded (token) parameter to search on
...... valueSet Σ0..1canonical(ValueSet)Valueset for the filter
...... code Σ0..*CodingWhat code is expected
..... dateFilter ΣI0..*ElementWhat dates/date ranges are expected
drq-2: Either a path or a searchParam must be provided, but not both
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ0..1stringA date-valued attribute to filter on
...... searchParam Σ0..1stringA date valued parameter to search on
...... value[x] Σ0..1The value of the filter, as a Period, DateTime, or Duration value
....... valueDateTimedateTime
....... valuePeriodPeriod
....... valueDurationDuration
..... limit Σ0..1positiveIntNumber of results
..... sort Σ0..*ElementOrder of the results
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... path Σ1..1stringThe name of the attribute to perform the sort
...... direction Σ1..1codeascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.

.... relatedAction S0..*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 S1..1idWhat action is this related to
..... relationship S1..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.

..... Slices for offset[x] 0..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place
.... 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: CSV, Excel, 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.codeextensibleUSPublicHealthPlanDefinitionAction
PlanDefinition.action.subject[x]extensibleSubjectType
PlanDefinition.action.trigger.typerequiredFixed Value: named-event
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.input.typerequiredFHIRAllTypes
PlanDefinition.action.input.subject[x]extensibleSubjectType
PlanDefinition.action.input.sort.directionrequiredSortDirection
PlanDefinition.action.output.typerequiredFHIRAllTypes
PlanDefinition.action.output.subject[x]extensibleSubjectType
PlanDefinition.action.output.sort.directionrequiredSortDirection
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

IdGradePathDetailsRequirements
dom-2errorPlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPlanDefinitionIf 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-4errorPlanDefinitionIf 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-5errorPlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticePlanDefinitionA resource should have narrative for robust management
: text.`div`.exists()
pdf-0warningPlanDefinitionName 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-1errorPlanDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.extension:receiverAddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.extension:receiverAddressMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.effectivePeriod.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.effectivePeriod.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.effectivePeriod.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.effectivePeriod.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.libraryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.goal.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.goal.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.goal.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.goal.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.goal.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.goal.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.goal.target.measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.target.detail[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.goal.target.dueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.textEquivalentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.goalIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.triggerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.trigger.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.trigger.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.trigger.extension:namedEventTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.trigger.extension:namedEventTypeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.trigger.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.trigger.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.trigger.timing[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.trigger.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.trigger.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.condition.kindAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.condition.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.inputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.input.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.input.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.mustSupportAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-1errorPlanDefinition.action.input.codeFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorPlanDefinition.action.input.codeFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.codeFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.input.codeFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.input.codeFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.codeFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.codeFilter.valueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.codeFilter.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-2errorPlanDefinition.action.input.dateFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorPlanDefinition.action.input.dateFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.dateFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.input.dateFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.input.dateFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.dateFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.dateFilter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.limitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.sortAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.sort.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.input.sort.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.input.sort.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.input.sort.directionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.outputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.output.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.output.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.mustSupportAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-1errorPlanDefinition.action.output.codeFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorPlanDefinition.action.output.codeFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.codeFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.output.codeFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.output.codeFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.codeFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.codeFilter.valueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.codeFilter.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
drq-2errorPlanDefinition.action.output.dateFilterEither a path or a searchParam must be provided, but not both
: path.exists() xor searchParam.exists()
ele-1errorPlanDefinition.action.output.dateFilterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.dateFilter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.output.dateFilter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.output.dateFilter.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.dateFilter.searchParamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.dateFilter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.limitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.sortAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.sort.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.output.sort.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.output.sort.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.output.sort.directionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.relatedAction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.relatedAction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.relatedAction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.relatedAction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.relatedAction.actionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.relatedAction.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.relatedAction.offset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.relatedAction.offset[x]:offsetDurationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.timing[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.participant.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.groupingBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.selectionBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.requiredBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.precheckBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.cardinalityBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.definition[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.transformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.dynamicValueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.dynamicValue.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.dynamicValue.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.dynamicValue.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPlanDefinition.action.dynamicValue.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPlanDefinition.action.dynamicValue.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.dynamicValue.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPlanDefinition.action.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())