Union of http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition and http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition

This is the set of resources that conform to either of the profiles SoaPlanDefinition (http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition) and SoaPlanDefinition (http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition). E.g. what you have to deal with if you get resources conforming to one of them

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*The definition of a plan for a series of actions, independent of any specific patient or context
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3: goalid should reference the id of a goal definition
pld-4: targetId should reference the id of an action
... meta Σ0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1codeLanguage of the resource content
Binding: ?? (required): IETF language tag for a human language


ele-1: All FHIR elements must have a @value or children
... text 0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url ΣC0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
ele-1: All FHIR elements must have a @value or children
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
ele-1: All FHIR elements must have a @value or children
... version Σ0..1stringBusiness version of the plan definition
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: ?? (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name Σ0..1stringName for this plan definition (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title Σ0..1stringName for this plan definition (human friendly)
ele-1: All FHIR elements must have a @value or children
... subtitle 0..1stringSubordinate title of the plan definition
ele-1: All FHIR elements must have a @value or children
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: ?? (extensible): The type of PlanDefinition.


ele-1: All FHIR elements must have a @value or children
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: ?? (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ0..1booleanFor testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... subject[x] 0..1Type of individual the plan definition is focused on
Binding: ?? (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).


ele-1: All FHIR elements must have a @value or children
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
ele-1: All FHIR elements must have a @value or children
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact Σ0..*ContactDetailContact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description Σ0..1markdownNatural language description of the plan definition
ele-1: All FHIR elements must have a @value or children
... useContext Σ0..*UsageContextThe context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose 0..1markdownWhy this plan definition is defined
ele-1: All FHIR elements must have a @value or children
... usage 0..1markdownDescribes the clinical usage of the plan
ele-1: All FHIR elements must have a @value or children
... copyright 0..1markdownUse and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel 0..1stringCopyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1dateWhen the plan definition was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1dateWhen the plan definition was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
ele-1: All FHIR elements must have a @value or children
... author 0..*ContactDetailWho authored the content
ele-1: All FHIR elements must have a @value or children
... editor 0..*ContactDetailWho edited the content
ele-1: All FHIR elements must have a @value or children
... reviewer 0..*ContactDetailWho reviewed the content
ele-1: All FHIR elements must have a @value or children
... endorser 0..*ContactDetailWho endorsed the content
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
ele-1: All FHIR elements must have a @value or children
... library 0..*canonical(Library)Logic used by the plan definition
ele-1: All FHIR elements must have a @value or children
... goal 0..*BackboneElementWhat the plan is trying to accomplish
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: ?? (example): Example codes for grouping goals for filtering or presentation.


ele-1: All FHIR elements must have a @value or children
.... description 1..1CodeableConceptCode or text describing the goal
Binding: ?? (example): Describes goals that can be achieved.


ele-1: All FHIR elements must have a @value or children
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: ?? (preferred): Indicates the level of importance associated with reaching or sustaining a goal.


ele-1: All FHIR elements must have a @value or children
.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: ?? (example): Identifies the types of events that might trigger the start of a goal.


ele-1: All FHIR elements must have a @value or children
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: ?? (example): Identifies problems, conditions, issues, or concerns that goals may address.


ele-1: All FHIR elements must have a @value or children
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
ele-1: All FHIR elements must have a @value or children
.... target 0..*BackboneElementTarget outcome for the goal
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: ?? (example): Identifies types of parameters that can be tracked to determine goal achievement.


ele-1: All FHIR elements must have a @value or children
..... detail[x] 0..1The target value to be achieved
ele-1: All FHIR elements must have a @value or children
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
...... detailStringstring
...... detailBooleanboolean
...... detailIntegerinteger
...... detailRatioRatio
..... due 0..1DurationReach goal within
ele-1: All FHIR elements must have a @value or children
... actor 0..*BackboneElementActors within the plan
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... title 0..1stringUser-visible title
ele-1: All FHIR elements must have a @value or children
.... description 0..1markdownDescribes the actor
ele-1: All FHIR elements must have a @value or children
.... option 1..*BackboneElementWho or what can be this actor
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ?? (required): The type of participant in the activity.


ele-1: All FHIR elements must have a @value or children
..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
ele-1: All FHIR elements must have a @value or children
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
ele-1: All FHIR elements must have a @value or children
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
... action 0..*BackboneElementAction defined by the plan
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionExtension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... linkId 0..1stringUnique id for the action in the PlanDefinition
ele-1: All FHIR elements must have a @value or children
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
ele-1: All FHIR elements must have a @value or children
.... title 0..1stringUser-visible title
ele-1: All FHIR elements must have a @value or children
.... description 0..1markdownBrief description of the action
ele-1: All FHIR elements must have a @value or children
.... textEquivalent 0..1markdownStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
ele-1: All FHIR elements must have a @value or children
.... priority 0..1coderoutine | urgent | asap | stat
Binding: ?? (required): Identifies the level of importance to be assigned to actioning the request.


ele-1: All FHIR elements must have a @value or children
.... code 0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: ?? (example): Provides examples of actions to be performed.


ele-1: All FHIR elements must have a @value or children
.... reason 0..*CodeableConceptWhy the action should be performed
Binding: ?? (example): Provides examples of reasons for actions to be performed.


ele-1: All FHIR elements must have a @value or children
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
ele-1: All FHIR elements must have a @value or children
.... goalId 0..*idWhat goals this action supports
ele-1: All FHIR elements must have a @value or children
.... subject[x] 0..1Type of individual the action is focused on
Binding: ?? (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).


ele-1: All FHIR elements must have a @value or children
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
..... subjectCanonicalcanonical(Any)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
ele-1: All FHIR elements must have a @value or children
.... condition 0..*BackboneElementWhether or not the action is applicable
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... kind 1..1codeapplicability | start | stop
Binding: ?? (required): Defines the kinds of conditions that can appear on actions.


ele-1: All FHIR elements must have a @value or children
..... expression 0..1ExpressionBoolean-valued expression
ele-1: All FHIR elements must have a @value or children
.... input C0..*BackboneElementInput data requirements
ele-1: All FHIR elements must have a @value or children
pld-0: Input data elements must have a requirement or a relatedData, but not both
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title 0..1stringUser-visible title
ele-1: All FHIR elements must have a @value or children
..... requirement 0..1DataRequirementWhat data is provided
ele-1: All FHIR elements must have a @value or children
..... relatedData 0..1idWhat data is provided
ele-1: All FHIR elements must have a @value or children
.... output C0..*BackboneElementOutput data definition
ele-1: All FHIR elements must have a @value or children
pld-1: Output data element must have a requirement or a relatedData, but not both
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title 0..1stringUser-visible title
ele-1: All FHIR elements must have a @value or children
..... requirement 0..1DataRequirementWhat data is provided
ele-1: All FHIR elements must have a @value or children
..... relatedData 0..1stringWhat data is provided
ele-1: All FHIR elements must have a @value or children
.... relatedAction 0..*BackboneElementRelationship to another action
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... targetId 1..1idWhat action is this related to
ele-1: All FHIR elements must have a @value or children
..... relationship 1..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ?? (required): Defines the types of relationships between actions.


ele-1: All FHIR elements must have a @value or children
..... endRelationship 0..1codebefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ?? (required): Defines the types of relationships between actions.


ele-1: All FHIR elements must have a @value or children
..... offset[x] 0..1Time offset for the relationship
ele-1: All FHIR elements must have a @value or children
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
ele-1: All FHIR elements must have a @value or children
..... timingAgeAge
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
ele-1: All FHIR elements must have a @value or children
.... participant 0..*BackboneElementWho should participate in the action
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... actorId 0..1stringWhat actor
ele-1: All FHIR elements must have a @value or children
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ?? (required): The type of participant in the activity.


ele-1: All FHIR elements must have a @value or children
..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
ele-1: All FHIR elements must have a @value or children
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
ele-1: All FHIR elements must have a @value or children
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ?? (example): Defines roles played by participants for the action.


ele-1: All FHIR elements must have a @value or children
..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ?? (extensible): The type of action to be performed.


ele-1: All FHIR elements must have a @value or children
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ?? (required): Defines organization behavior of a group.


ele-1: All FHIR elements must have a @value or children
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ?? (required): Defines selection behavior of a group.


ele-1: All FHIR elements must have a @value or children
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ?? (required): Defines expectations around whether an action or action group is required.


ele-1: All FHIR elements must have a @value or children
.... precheckBehavior 0..1codeyes | no
Binding: ?? (required): Defines selection frequency behavior for an action or group.


ele-1: All FHIR elements must have a @value or children
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ?? (required): Defines behavior for an action or a group for how many times that item may be repeated.


ele-1: All FHIR elements must have a @value or children
.... definition[x] 0..1Description of the activity to be performed
ele-1: All FHIR elements must have a @value or children
..... definitionCanonicalcanonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
ele-1: All FHIR elements must have a @value or children
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
ele-1: All FHIR elements must have a @value or children
..... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... path 0..1stringThe path to the element to be set dynamically
ele-1: All FHIR elements must have a @value or children
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
ele-1: All FHIR elements must have a @value or children
.... action 0..*A sub-action
ele-1: All FHIR elements must have a @value or children
... asNeeded[x] Σ0..1Preconditions for service
Binding: ?? (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.


ele-1: All FHIR elements must have a @value or children
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept

doco Documentation for this format