Clinical Practice Guidelines (CPG) on EBMonFHIR
0.8.0-snapshot - ci-build

Clinical Practice Guidelines (CPG) on EBMonFHIR - Local Development build (v0.8.0-snapshot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Recommendation

Defining URL:https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/recommendation
Version:0.1.0
Name:Recommendation
Status:Draft as of 2022-10-03
Definition:

A recommendation as part of a clinical practice guideline.

Publisher:Netzwerk Universitätsmedizin (NUM),
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Guidance

This profile of a FHIR PlanDefinition is derived from the cpg-strategydefinition 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 CPGStrategyDefinition 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
selection-behavior-unique-or-no-value: If selectionBehavior is present, it must be the same for all actions in the group
nested-action-requires-combination-method: If a nested action is present, a combination method must be present.
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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 3..* Extension Extension
Slice: Unordered, Open by value:url
... knowledgeCapability S 1..1 (Complex) shareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability"
.... value[x] 1..1 code Value of extension
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


Required Pattern: computable
... knowledgeRepresentationLevel S 1..1 (Complex) narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel"
.... value[x] 1..1 code Value of extension
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


Required Pattern: structured
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
... enabled S 0..1 boolean Enabled?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
... partOf S 0..1 canonical(PlanDefinition) Part of pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
... combinationMethod S 1..1 (Complex) combinationMethod
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method
... 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 SΣ 1..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: workflow-definition
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... 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] S 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
... Slices for relatedArtifact 0..* RelatedArtifact Additional documentation, citations
Slice: Unordered, Open by value:classifier
.... relatedArtifact:recommendationJustification 0..1 RelatedArtifact Additional documentation, citations
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: justification
..... classifier Σ 1..1 CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.



Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: recommendation-rating
....... display 1..1 string Representation defined by the system
Fixed Value: Recommendation rating
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... label Σ 0..1 string Short label
..... display Σ 0..1 string Brief description of the related artifact
..... citation Σ 0..1 markdown Bibliographic citation for the artifact
..... document Σ 0..1 Attachment What document is being referenced
..... resource Σ 0..1 canonical(Resource) What artifact is being referenced
..... resourceReference SΣ 1..1 Reference(Recommendation Justification) What artifact, if not a conformance resource
..... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

..... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
.... relatedArtifact:recommendationCitation 0..1 RelatedArtifact Additional documentation, citations
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: citation
..... classifier Σ 1..1 CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.



Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: guideline-recommendation
....... display 1..1 string Representation defined by the system
Fixed Value: Clinical practice guideline recommendation
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... label Σ 0..1 string Short label
..... display Σ 0..1 string Brief description of the related artifact
..... citation Σ 0..1 markdown Bibliographic citation for the artifact
..... document Σ 0..1 Attachment What document is being referenced
..... resource Σ 0..1 canonical(Resource) What artifact is being referenced
..... resourceReference SΣ 1..1 Reference(Recommendation Citation) What artifact, if not a conformance resource
..... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

..... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
.... relatedArtifact:guidelineCitation 0..1 RelatedArtifact Additional documentation, citations
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: citation
..... classifier Σ 1..1 CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.



Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical-practice-guideline
....... display 1..1 string Representation defined by the system
Fixed Value: Clinical practice guideline
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... label Σ 0..1 string Short label
..... display Σ 0..1 string Brief description of the related artifact
..... citation Σ 0..1 markdown Bibliographic citation for the artifact
..... document Σ 0..1 Attachment What document is being referenced
..... resource Σ 0..1 canonical(Resource) What artifact is being referenced
..... resourceReference SΣ 1..1 Reference(Guideline Citation) What artifact, if not a conformance resource
..... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

..... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... library S 0..1 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 SC 1..* BackboneElement Action defined by the plan
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... strengthOfRecommendation S 0..1 CodeableConcept The strength of the recommendation
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
.... directionOfRecommendation S 0..1 CodeableConcept Recommendation for or against?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
Binding: CPG Recommendation Direction (required): The direction of the recommendation, for or against


.... qualityOfEvidence S 0..1 CodeableConcept The quality of the evidence
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix S 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title S 1..1 string User-visible title
.... description S 1..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 S 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: CPG Common Process (extensible): High-level processes identified in guideline-based care

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


.... documentation S 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 S 0..* TriggerDefinition When the action should be triggered
.... condition S 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 SC 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 SC 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 SC 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] S 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 S 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 S 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: CPG Common Persona (preferred): Personas used in identifying participants and their roles in computable content

..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
.... selectionBehavior S 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.

.... definition[x] S 1..1 canonical(Recommendation Plan) Description of the activity to be performed
.... action S 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 CPGStrategyDefinition The definition of a plan for a series of actions, independent of any specific patient or context
​... meta Σ 1..1 Meta Metadata about the resource
​.... source Σ 0..1 uri Identifies where the resource comes from
​.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
​... knowledgeCapability 1..1 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 1..1 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


​... enabled 0..1 boolean Enabled?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enabled
​... partOf 0..1 canonical(PlanDefinition) Part of pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-partOf
​... combinationMethod 1..1 (Complex) combinationMethod
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method
​... 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
​... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... 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)
​... type Σ 1..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: workflow-definition
​... experimental Σ 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)
​... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
​... description Σ 1..1 markdown Natural language description of the plan definition
​... relatedArtifact:recommendationJustification 0..1 RelatedArtifact Additional documentation, citations
​.... resourceReference Σ 1..1 Reference(Recommendation Justification) What artifact, if not a conformance resource
​... relatedArtifact:recommendationCitation 0..1 RelatedArtifact Additional documentation, citations
​.... resourceReference Σ 1..1 Reference(Recommendation Citation) What artifact, if not a conformance resource
​... relatedArtifact:guidelineCitation 0..1 RelatedArtifact Additional documentation, citations
​.... resourceReference Σ 1..1 Reference(Guideline Citation) What artifact, if not a conformance resource
​... library 0..1 canonical(Library) Logic used by the plan definition
​... action C 1..* BackboneElement Action defined by the plan
​.... strengthOfRecommendation 0..1 CodeableConcept The strength of the recommendation
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
​.... directionOfRecommendation 0..1 CodeableConcept Recommendation for or against?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
Binding: CPG Recommendation Direction (required): The direction of the recommendation, for or against


​.... qualityOfEvidence 0..1 CodeableConcept The quality of the evidence
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
​.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
​.... title 1..1 string User-visible title
​.... description 1..1 markdown Brief description of the action
​.... code 1..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: CPG Common Process (extensible): High-level processes identified in guideline-based care

​.... 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
​.... trigger 0..* TriggerDefinition When the action should be triggered
​.... condition 0..* BackboneElement Whether or not the action is applicable
​.... input C 0..* BackboneElement Input data requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both
​.... output C 0..* BackboneElement Output data definition
pld-1: Output data element must have a requirement or a relatedData, but not both
​.... relatedAction C 0..* BackboneElement Relationship to another action
​.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
​.... participant 0..* BackboneElement Who should participate in the action
​..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: CPG Common Persona (preferred): Personas used in identifying participants and their roles in computable content

​.... 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.

​.... definition[x] 1..1 canonical(Recommendation Plan) Description of the activity to be performed
​.... action 0..* See action (PlanDefinition) A sub-action

doco Documentation for this format

This structure is derived from CPGStrategyDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 1..1 CPGStrategyDefinition The definition of a plan for a series of actions, independent of any specific patient or context
selection-behavior-unique-or-no-value: If selectionBehavior is present, it must be the same for all actions in the group
nested-action-requires-combination-method: If a nested action is present, a combination method must be present.
... meta S 1..1 Meta Metadata about the resource
.... source S 0..1 uri Identifies where the resource comes from
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... extension 3..* Extension Extension
... extension:knowledgeCapability 1..1 CPGKnowledgeCapability shareable | computable | publishable | executable
.... extension 0..0
.... value[x] 1..1 code Value of extension
Required Pattern: computable
.... extension 0..0
.... value[x] 1..1 code Value of extension
Required Pattern: structured
... combinationMethod S 1..1 (Complex) combinationMethod
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method
... Slices for relatedArtifact 0..* RelatedArtifact Additional documentation, citations
Slice: Unordered, Open by value:classifier
.... relatedArtifact:recommendationJustification 0..1 RelatedArtifact Additional documentation, citations
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Required Pattern: justification
..... classifier 1..1 CodeableConcept Additional classifiers
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: recommendation-rating
....... display 1..1 string Representation defined by the system
Fixed Value: Recommendation rating
..... resourceReference S 1..1 Reference(Recommendation Justification) What artifact, if not a conformance resource
.... relatedArtifact:recommendationCitation 0..1 RelatedArtifact Additional documentation, citations
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Required Pattern: citation
..... classifier 1..1 CodeableConcept Additional classifiers
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: guideline-recommendation
....... display 1..1 string Representation defined by the system
Fixed Value: Clinical practice guideline recommendation
..... resourceReference S 1..1 Reference(Recommendation Citation) What artifact, if not a conformance resource
.... relatedArtifact:guidelineCitation 0..1 RelatedArtifact Additional documentation, citations
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Required Pattern: citation
..... classifier 1..1 CodeableConcept Additional classifiers
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/CodeSystem/ceosys-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical-practice-guideline
....... display 1..1 string Representation defined by the system
Fixed Value: Clinical practice guideline
..... resourceReference S 1..1 Reference(Guideline Citation) What artifact, if not a conformance resource
... action
.... definition[x] 1..1 canonical(Recommendation Plan) Description of the activity to be performed

doco Documentation for this format

This structure is derived from CPGStrategyDefinition

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PlanDefinition.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PlanDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.extension:knowledgeCapability.value[x]requiredPattern: computable
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-capability
PlanDefinition.extension:knowledgeRepresentationLevel.value[x]requiredPattern: structured
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-representation-level
PlanDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
PlanDefinition.typeextensiblePattern: workflow-definition
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.relatedArtifact:recommendationJustification.typerequiredPattern: justification
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:recommendationJustification.classifierexamplePattern: recommendation-rating("Recommendation rating")
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:recommendationJustification.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:recommendationCitation.typerequiredPattern: citation
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:recommendationCitation.classifierexamplePattern: guideline-recommendation("Clinical practice guideline recommendation")
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:recommendationCitation.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:guidelineCitation.typerequiredPattern: citation
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:guidelineCitation.classifierexamplePattern: clinical-practice-guideline("Clinical practice guideline")
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:guidelineCitation.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
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.codeextensibleCPG_Common_Process
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-common-process
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.rolepreferredCPG_Common_Persona
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-common-persona
PlanDefinition.action.participant.functionexampleActionParticipantFunction
http://hl7.org/fhir/ValueSet/action-participant-function
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-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

Constraints

IdGradePath(s)DetailsRequirements
nested-action-requires-combination-methoderrorPlanDefinitionIf a nested action is present, a combination method must be present.
: action.exists() implies extension('https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-action-combination-method').exists()
selection-behavior-unique-or-no-valueerrorPlanDefinitionIf selectionBehavior is present, it must be the same for all actions in the group
: action.selectionBehavior.distinct().count() <= 1