Clinical Practice Guidelines (CPG) on EBMonFHIR
1.0.2 - ci-build

Clinical Practice Guidelines (CPG) on EBMonFHIR, published by Universitätsmedizin Greifswald. This guide is not an authorized publication; it is the continuous build for version 1.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CEOsys/cpg-on-ebm-on-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: CPGShareablePlanDefinition

Defining URL:https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cpg-shareableplandefinition
Version:1.0.0
Name:CPGShareablePlanDefinition
Status:Draft as of 2019-06-06
Definition:

Defines the minimum expectations for a shareable plan definition for use with computable guideline content. This profile derives from the ShareablePlanDefinition profile defined in the base FHIR specification, and adds support for declaring knowledge representation level and knowledge artifact capabilities.

Publisher:Health Level Seven, Inc. - CDS WG,
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cpg-shareableplandefinition

Guidance

This profile of a FHIR PlanDefinition is derived from the shareableplandefinition FHIR resource.

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 1..1 ShareablePlanDefinition This is an abstractprofile. Childprofiles: CPGComputablePlanDefinition
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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


.... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical 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
... identifier Σ 0..* Identifier Additional identifier for the plan definition
... version SΣ 1..1 string Business version of the plan definition
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 0..1 string Name for this plan definition (computer friendly)
... title SΣ 1..1 string Name for this plan definition (human friendly)
... subtitle 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.

... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonical canonical(EvidenceVariable)
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..1 markdown Natural language description of the plan definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this plan definition is defined
... usage 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations
... library 0..* canonical(Library) Logic used by the plan definition
... goal C 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

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

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

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

.... addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... measure 0..1 CodeableConcept The 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..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 0..1 string User-visible title
.... description 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example)
... action C 0..* BackboneElement Action defined by the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title 0..1 string User-visible title
.... description 0..1 markdown Brief description of the action
.... textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCode (example): Provides examples of actions to be performed.

.... reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.


.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goalId C 0..* id What goals this action supports
.... subject[x] 0..1 Type of individual the action is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical(Any)
.... trigger 0..* TriggerDefinition When the action should be triggered
.... condition 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
pld-1: Output data element must have a requirement or a relatedData, but not both
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction C 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... targetId C 1..1 id What action is this related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should participate in the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actorId 0..1 string What actor
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role (example): Defines roles played by participants for the action.

..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

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

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

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

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

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

.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (PlanDefinition) A sub-action
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1 ShareablePlanDefinition This is an abstractprofile. Childprofiles: CPGComputablePlanDefinition
The definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension Content/Rules for all slices
.... knowledgeCapability 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


.... knowledgeRepresentationLevel 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


.... artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... url ΣC 1..1 uri Canonical 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
... version Σ 1..1 string Business version of the plan definition
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title Σ 1..1 string Name for this plan definition (human friendly)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... description Σ 1..1 markdown Natural language description of the plan definition

doco Documentation for this format

This structure is derived from ShareablePlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1 ShareablePlanDefinition This is an abstractprofile. Childprofiles: CPGComputablePlanDefinition
The definition of a plan for a series of actions, independent of any specific patient or context

doco Documentation for this format

This structure is derived from ShareablePlanDefinition

Summary

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
PlanDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
PlanDefinition.typeextensiblePlanDefinitionType
http://hl7.org/fhir/ValueSet/plan-definition-type
from the FHIR Standard
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PlanDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
PlanDefinition.goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
PlanDefinition.goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
PlanDefinition.goal.startexampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
PlanDefinition.goal.addressesexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
PlanDefinition.goal.target.measureexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
PlanDefinition.actor.option.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.actor.option.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
PlanDefinition.action.codeexampleActionCode
http://hl7.org/fhir/ValueSet/action-code
from the FHIR Standard
PlanDefinition.action.reasonexampleActionReasonCode
http://hl7.org/fhir/ValueSet/action-reason-code
from the FHIR Standard
PlanDefinition.action.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredActionConditionKind
http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.endRelationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.participant.functionexampleActionParticipantFunction
http://hl7.org/fhir/ValueSet/action-participant-function
from the FHIR Standard
PlanDefinition.action.typeextensibleActionType
http://hl7.org/fhir/ValueSet/action-type
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior
http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0
from the FHIR Standard
PlanDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard