US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health PlanDefinition

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition Version: 1.0.0
Active as of 2023-08-16 Computable Name: USPublicHealthPlanDefinition

This PlanDefinition profile describes the US Public Health PlanDefinition.

This profile is used to represent Knowledge Artifacts in US Public Health use cases.

Usage:

Formal Views of Profile Content

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

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... title 1..1stringTitle for this PlanDefinition
... type S1..1CodeableConceptType of this PlanDefinition
Required Pattern: At least the following
.... coding1..*CodingCode 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 1..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 VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition

.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... namedEventType S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - 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
..... Slices for offset[x] 0..1Duration, RangeTime offset for the relationship
Slice: Unordered, Open by type:$this
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... contentEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-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ΣC1..1stringName for this PlanDefinition (computer friendly)
... title SΣ1..1stringTitle for this PlanDefinition
... type SΣ1..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... coding1..*CodingCode 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
... 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.


... effectivePeriod SΣ0..1PeriodWhen the PlanDefinition is valid
.... start ΣC1..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.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S0..1stringBrief description of the action
.... code S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition


.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... namedEventType S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - 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
.... condition S0..*BackboneElementWhether or not the action is applicable
..... 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
..... 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.

.... output S0..*DataRequirementOutput data definition
..... 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.

.... relatedAction S0..*BackboneElementRelationship to another action
..... 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..1Time offset for the relationship
Slice: Unordered, Open by type:$this
...... offsetDurationDuration
...... offsetRangeRange
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.typeextensiblePattern: workflow-definition("Workflow Definition")
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)
PlanDefinition.action.trigger.typerequiredFixed Value: named-event
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.input.typerequiredFHIRAllTypes
PlanDefinition.action.output.typerequiredFHIRAllTypes
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... contentEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-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ΣC1..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.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..1stringVersion 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..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain 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
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC1..1dateTimeThe start of the time period when this PlanDefinition goes into effect
.... end ΣC0..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 VaueSet - 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
..... namedEventType S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - 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
..... 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 ΣC0..*ElementWhat codes are expected
...... id 0..1stringUnique id for inter-element referencing
...... 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 ΣC0..*ElementWhat dates/date ranges are expected
...... id 0..1stringUnique id for inter-element referencing
...... 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
...... 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
..... 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 ΣC0..*ElementWhat codes are expected
...... id 0..1stringUnique id for inter-element referencing
...... 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 ΣC0..*ElementWhat dates/date ranges are expected
...... id 0..1stringUnique id for inter-element referencing
...... 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
...... 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..1Time offset for the relationship
Slice: Unordered, Open by type:$this
...... offsetDurationDuration
...... offsetRangeRange
...... 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

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PlanDefinition.typeextensiblePattern: 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 (a valid code from LOINC)
PlanDefinition.action.priorityrequiredRequestPriority
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)
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

Differential View

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... title 1..1stringTitle for this PlanDefinition
... type S1..1CodeableConceptType of this PlanDefinition
Required Pattern: At least the following
.... coding1..*CodingCode 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 1..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 VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition

.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... namedEventType S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - 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
..... Slices for offset[x] 0..1Duration, RangeTime offset for the relationship
Slice: Unordered, Open by type:$this
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... contentEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-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ΣC1..1stringName for this PlanDefinition (computer friendly)
... title SΣ1..1stringTitle for this PlanDefinition
... type SΣ1..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... coding1..*CodingCode 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
... 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.


... effectivePeriod SΣ0..1PeriodWhen the PlanDefinition is valid
.... start ΣC1..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.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S0..1stringBrief description of the action
.... code S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition


.... trigger S0..*TriggerDefinitionWhen the action should be triggered
..... namedEventType S0..1CodeableConceptUS Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - 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
.... condition S0..*BackboneElementWhether or not the action is applicable
..... 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
..... 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.

.... output S0..*DataRequirementOutput data definition
..... 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.

.... relatedAction S0..*BackboneElementRelationship to another action
..... 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..1Time offset for the relationship
Slice: Unordered, Open by type:$this
...... offsetDurationDuration
...... offsetRangeRange
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.typeextensiblePattern: workflow-definition("Workflow Definition")
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)
PlanDefinition.action.trigger.typerequiredFixed Value: named-event
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.input.typerequiredFHIRAllTypes
PlanDefinition.action.output.typerequiredFHIRAllTypes
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... contentEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-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ΣC1..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.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..1stringVersion 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..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... status ?!