D.4.1 StructureDefinition: cdc-plandefinition

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-plandefinition

Profile of PlanDefinition for use with CDC Opioid Prescribing Guidelines

This profile builds on PlanDefinition.

This profile was published on Fri Apr 21 00:00:00 UTC 2017 as a draft by Centers for Disease Control and Prevention.

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

This structure is derived from PlanDefinition

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 20 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*The 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this plan definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name Σ0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... type Σ0..1CodeableConceptorder-set | protocol | eca-rule
Binding: PlanDefinitionType (extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the plan definition
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactRelated artifacts for the asset
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1stringBibliographic citation for the artifact
.... url SΣ1..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1Reference(Resource)What resource is being referenced
... library S1..1Reference(Library)Logic used by the plan definition
... goal I0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral, etc
Binding: GoalCategory (example)
.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMED CT Clinical Findings (example)
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/Diagnosis Codes (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINC Codes (example)
..... detail[x] 0..1Quantity, Range, CodeableConceptThe target value to be achieved
..... due 0..1DurationReach goal within
... action SI1..*BackboneElementAction defined by the plan
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... triggerDefinition S0..*TriggerDefinitionWhen the action should be triggered
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... description 0..1stringNatural language description of the condition
..... language S1..1stringLanguage of the expression
..... expression S1..1stringBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... 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)
..... offset[x] 0..1Duration, RangeTime offset for the relationship
.... timing[x] 0..1dateTime, Period, Duration, Range, TimingWhen the action should take place
.... participant I0..*BackboneElementWho should participate in the action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... type 1..1codepatient | practitioner | related-person
Binding: ActionParticipantType (required)
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (example)
.... type S0..1Codingcreate | update | remove | fire-event
Binding: ActionType (required)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... definition S0..1Reference(ActivityDefinition | PlanDefinition)Description of the activity to be performed
.... transform 0..1Reference(StructureMap)Transform to apply the template
.... dynamicValue SI0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... description 0..1stringNatural language description of the dynamic value
..... path S0..1stringThe path to the element to be set dynamically
..... language S0..1stringLanguage of the expression
..... expression S0..1stringAn expression that provides the dynamic value for the customization
.... action S0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

This structure is derived from http://hl7.org/fhir/STU3/plandefinition.html.

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 20 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*The 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this plan definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name Σ0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... type Σ0..1CodeableConceptorder-set | protocol | eca-rule
Binding: PlanDefinitionType (extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the plan definition
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactRelated artifacts for the asset
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1stringBibliographic citation for the artifact
.... url SΣ1..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1Reference(Resource)What resource is being referenced
... library S1..1Reference(Library)Logic used by the plan definition
... goal I0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral, etc
Binding: GoalCategory (example)
.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMED CT Clinical Findings (example)
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/Diagnosis Codes (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINC Codes (example)
..... detail[x] 0..1Quantity, Range, CodeableConceptThe target value to be achieved
..... due 0..1DurationReach goal within
... action SI1..*BackboneElementAction defined by the plan
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... triggerDefinition S0..*TriggerDefinitionWhen the action should be triggered
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... description 0..1stringNatural language description of the condition
..... language S1..1stringLanguage of the expression
..... expression S1..1stringBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... 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)
..... offset[x] 0..1Duration, RangeTime offset for the relationship
.... timing[x] 0..1dateTime, Period, Duration, Range, TimingWhen the action should take place
.... participant I0..*BackboneElementWho should participate in the action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... type 1..1codepatient | practitioner | related-person
Binding: ActionParticipantType (required)
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (example)
.... type S0..1Codingcreate | update | remove | fire-event
Binding: ActionType (required)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... definition S0..1Reference(ActivityDefinition | PlanDefinition)Description of the activity to be performed
.... transform 0..1Reference(StructureMap)Transform to apply the template
.... dynamicValue SI0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... description 0..1stringNatural language description of the dynamic value
..... path S0..1stringThe path to the element to be set dynamically
..... language S0..1stringLanguage of the expression
..... expression S0..1stringAn expression that provides the dynamic value for the customization
.... action S0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
PlanDefinition.languageCommon LanguagesextensibleCommon Languages
PlanDefinition.typePlanDefinitionTypeextensiblePlanDefinitionType
PlanDefinition.statusPublicationStatusrequiredPublicationStatus
PlanDefinition.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
PlanDefinition.topicDefinitionTopicexampleDefinitionTopic
PlanDefinition.relatedArtifact.typeRelatedArtifactTyperequiredRelatedArtifactType
PlanDefinition.goal.categoryGoalCategoryexampleGoalCategory
PlanDefinition.goal.descriptionSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings
PlanDefinition.goal.priorityGoalPrioritypreferredGoalPriority
PlanDefinition.goal.startGoalStartEventexampleGoalStartEvent
PlanDefinition.goal.addressesCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
PlanDefinition.goal.target.measureLOINC CodesexampleLOINC Codes
PlanDefinition.action.condition.kindActionConditionKindrequiredActionConditionKind
PlanDefinition.action.relatedAction.relationshipActionRelationshipTyperequiredActionRelationshipType
PlanDefinition.action.participant.typeActionParticipantTyperequiredActionParticipantType
PlanDefinition.action.participant.roleActionParticipantRoleexampleActionParticipantRole
PlanDefinition.action.typeActionTyperequiredActionType
PlanDefinition.action.groupingBehaviorActionGroupingBehaviorrequiredActionGroupingBehavior
PlanDefinition.action.selectionBehaviorActionSelectionBehaviorrequiredActionSelectionBehavior
PlanDefinition.action.requiredBehaviorActionRequiredBehaviorrequiredActionRequiredBehavior
PlanDefinition.action.precheckBehaviorActionPrecheckBehaviorrequiredActionPrecheckBehavior
PlanDefinition.action.cardinalityBehaviorActionCardinalityBehaviorrequiredActionCardinalityBehavior

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1PlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4PlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3PlanDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1PlanDefinition.goalAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.goal.targetAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.actionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.action.conditionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.action.participantAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValueAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.

s