FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cpg-protocoldefinition

Examples:

Example id Format
ANC Contact Schedule Protocol Definition anc-contact-schedule XML JSON
CPG Common Pathway Protocol Definition cpg-common-pathway XML JSON
VA Chronic Kidney Disease (CKD) Protocol Definition va-ckd-protocol XML JSON

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-protocoldefinition

Profile of PlanDefinition as a Clinical Protocol for use with CPG Implementation Guide

This profile builds on CPGPlanDefinition.

This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 3 elements
Fixed Value: 1 element
Prohibited: 11 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1
... type 1..1CodeableConceptFixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display1..1stringRepresentation defined by the system
Fixed Value: Clinical Protocol
... action 1..*BackboneElement
.... title 1..1string
.... description 1..1string
.... code 1..1CodeableConceptBinding: CPG Common Process (extensible)
.... input 0..0
.... output 0..0
.... relatedAction 0..0
.... type 0..0
.... groupingBehavior 0..0
.... selectionBehavior 0..0
.... requiredBehavior 0..0
.... precheckBehavior 0..0
.... cardinalityBehavior 0..0
.... definition[x] 0..1canonical(PlanDefinition)
.... transform 0..0
.... dynamicValue 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I1..1The definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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 SΣ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version SΣ1..1stringBusiness version of the plan definition
... name SΣI1..1stringName for this plan definition (computer friendly)
... title Σ1..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ1..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible)
Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display1..1stringRepresentation defined by the system
Fixed Value: Clinical Protocol
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
... date Σ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the plan definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this plan definition is defined
... usage S0..1stringDescribes the clinical usage of the plan
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the plan definition was approved by publisher
... lastReviewDate S0..1dateWhen the plan definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the plan definition is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example)
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations
.... id 0..1stringUnique id for inter-element referencing
.... 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)
.... label Σ0..1stringShort label
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ1..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library S0..1canonical(Library)Logic used by the plan definition
... goal I0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example)
.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (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/DiagnosisCodes (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINCCodes (example)
..... detail[x] 0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action I1..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix S0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 1..1stringUser-visible title
.... description 1..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
.... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: CPG Common Process (extensible)
.... reason S0..*CodeableConceptWhy the action should be performed
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... cqf-strengthOfRecommendation S0..1CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation"
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: StrengthOfRecommendationRating (example)
..... cpg-directionOfRecommendation S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation"
...... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: CPG Recommendation Direction (required)
..... cqf-qualityOfEvidence S0..1CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence"
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QualityOfEvidenceRating (example)
..... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource Σ0..1canonical(Resource)What resource is being referenced
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Binding: SubjectType (extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
.... trigger S0..*TriggerDefinitionWhen the action should be triggered
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression 0..1ExpressionBoolean-valued expression
.... timing[x] S0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant SI0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
..... role S0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: CPG Common Persona (extensible)
.... definition[x] 0..1canonical(PlanDefinition)Description of the activity to be performed
.... action S0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

Summary

Mandatory: 3 elements
Fixed Value: 1 element
Prohibited: 11 elements

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1
... type 1..1CodeableConceptFixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display1..1stringRepresentation defined by the system
Fixed Value: Clinical Protocol
... action 1..*BackboneElement
.... title 1..1string
.... description 1..1string
.... code 1..1CodeableConceptBinding: CPG Common Process (extensible)
.... input 0..0
.... output 0..0
.... relatedAction 0..0
.... type 0..0
.... groupingBehavior 0..0
.... selectionBehavior 0..0
.... requiredBehavior 0..0
.... precheckBehavior 0..0
.... cardinalityBehavior 0..0
.... definition[x] 0..1canonical(PlanDefinition)
.... transform 0..0
.... dynamicValue 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I1..1The definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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 SΣ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version SΣ1..1stringBusiness version of the plan definition
... name SΣI1..1stringName for this plan definition (computer friendly)
... title Σ1..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ1..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible)
Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display1..1stringRepresentation defined by the system
Fixed Value: Clinical Protocol
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
... date Σ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the plan definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this plan definition is defined
... usage S0..1stringDescribes the clinical usage of the plan
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the plan definition was approved by publisher
... lastReviewDate S0..1dateWhen the plan definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the plan definition is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example)
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations
.... id 0..1stringUnique id for inter-element referencing
.... 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)
.... label Σ0..1stringShort label
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ1..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library S0..1canonical(Library)Logic used by the plan definition
... goal I0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example)
.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (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/DiagnosisCodes (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINCCodes (example)
..... detail[x] 0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action I1..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix S0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 1..1stringUser-visible title
.... description 1..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
.... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: CPG Common Process (extensible)
.... reason S0..*CodeableConceptWhy the action should be performed
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... cqf-strengthOfRecommendation S0..1CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation"
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: StrengthOfRecommendationRating (example)
..... cpg-directionOfRecommendation S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation"
...... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: CPG Recommendation Direction (required)
..... cqf-qualityOfEvidence S0..1CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence"
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QualityOfEvidenceRating (example)
..... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource Σ0..1canonical(Resource)What resource is being referenced
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Binding: SubjectType (extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
.... trigger S0..*TriggerDefinitionWhen the action should be triggered
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression 0..1ExpressionBoolean-valued expression
.... timing[x] S0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant SI0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
..... role S0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: CPG Common Persona (extensible)
.... definition[x] 0..1canonical(PlanDefinition)Description of the activity to be performed
.... action S0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
PlanDefinition.typeextensibleFixed Value: clinical-protocol("Clinical Protocol")
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.topicexampleDefinitionTopic
PlanDefinition.relatedArtifact.typerequiredRelatedArtifactType
PlanDefinition.goal.categoryexampleGoalCategory
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
PlanDefinition.goal.prioritypreferredGoalPriority
PlanDefinition.goal.startexampleGoalStartEvent
PlanDefinition.goal.addressesexampleCondition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measureexampleLOINCCodes
PlanDefinition.action.priorityrequiredRequestPriority
PlanDefinition.action.codeextensibleCPG_Common_Process
PlanDefinition.action.documentation.extension:strengthOfRecommendation.valueCodeableConceptexampleStrengthOfRecommendationRating
PlanDefinition.action.documentation.extension:directionOfRecommendation.value[x]:valueCodeableConceptrequiredCPG_Recommendation_Direction
PlanDefinition.action.documentation.extension:qualityOfEvidence.valueCodeableConceptexampleQualityOfEvidenceRating
PlanDefinition.action.documentation.typerequiredRelatedArtifactType
PlanDefinition.action.subject[x]extensibleSubjectType
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
PlanDefinition.action.participant.typerequiredActionParticipantType
PlanDefinition.action.participant.roleextensibleCPG_Common_Persona

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-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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6PlanDefinitionA resource should have narrative for robust management
: text.div.exists()
dom-5PlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
pdf-0PlanDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1PlanDefinition.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())