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
Example | id | Format | |
---|---|---|---|
ANC Contact Workflow Definition | anc-contact | XML | JSON |
CPG Common Registration Workflow Definition | cpg-common-registration | XML | JSON |
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-workflowdefinition
Profile of PlanDefinition as a Workflow Definition 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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | 1..1 | |||
type | 1..1 | CodeableConcept | Fixed Value: As shown | |
coding | 1..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 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
action | 1..* | BackboneElement | ||
title | 1..1 | string | ||
description | 1..1 | string | ||
code | 1..1 | CodeableConcept | Binding: CPG Common Process (extensible) | |
input | S | 0..* | DataRequirement | |
output | S | 0..* | DataRequirement | |
relatedAction | S | 0..* | BackboneElement | |
participant | 0..* | BackboneElement | ||
cpg-participantCapabilityStatement | S | 0..1 | canonical() | What capabilities the device has URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement |
type | 0..0 | |||
groupingBehavior | 0..0 | |||
selectionBehavior | 0..0 | |||
requiredBehavior | 0..0 | |||
precheckBehavior | 0..0 | |||
cardinalityBehavior | 0..0 | |||
definition[x] | 0..1 | canonical(PlanDefinition | Questionnaire | OperationDefinition | EventDefinition) | ||
transform | 0..0 | |||
dynamicValue | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | I | 1..1 | The definition of a plan for a series of actions, independent of any specific patient or context | |
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the plan definition |
version | SΣ | 1..1 | string | Business version of the plan definition |
name | SΣI | 1..1 | string | Name for this plan definition (computer friendly) |
title | Σ | 1..1 | string | Name for this plan definition (human friendly) |
subtitle | 0..1 | string | Subordinate title of the plan definition | |
type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..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..0 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(http://hl7.org/fhir/R4/group.html) | |||
date | Σ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | SΣ | 1..1 | markdown | Natural language description of the plan definition |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | S | 0..1 | markdown | Why this plan definition is defined |
usage | S | 0..1 | string | Describes the clinical usage of the plan |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the plan definition was approved by publisher |
lastReviewDate | S | 0..1 | date | When the plan definition was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the plan definition is expected to be used |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example) |
author | S | 0..* | ContactDetail | Who authored the content |
editor | S | 0..* | ContactDetail | Who edited the content |
reviewer | S | 0..* | ContactDetail | Who reviewed the content |
endorser | S | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations |
id | 0..1 | string | 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 Binding: RelatedArtifactType (required) |
label | Σ | 0..1 | string | Short label |
display | SΣ | 1..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 1..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | canonical(Resource) | What resource is being referenced |
library | S | 0..1 | canonical(Library) | Logic used by the plan definition |
goal | I | 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) | |
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example) | |
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) | |
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) | |
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example) | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |
target | I | 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) | |
detail[x] | 0..1 | The target value to be achieved | ||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | 0..1 | Duration | Reach goal within | |
action | I | 1..* | 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 |
prefix | S | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | 1..1 | string | User-visible title | |
description | 1..1 | string | Brief description of the action | |
textEquivalent | 0..1 | string | 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) | |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: CPG Common Process (extensible) | |
reason | S | 0..* | CodeableConcept | Why the action should be performed |
documentation | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqf-strengthOfRecommendation | S | 0..1 | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: StrengthOfRecommendationRating (example) | |
cpg-directionOfRecommendation | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation" | |
value[x] | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | ||
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: CPG Recommendation Direction (required) | |
cqf-qualityOfEvidence | S | 0..1 | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: QualityOfEvidenceRating (example) | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
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 |
url | Σ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | canonical(Resource) | What resource is being referenced |
goalId | 0..* | id | What goals this action supports | |
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(http://hl7.org/fhir/R4/group.html) | |||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered |
condition | SI | 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) | |
expression | 0..1 | Expression | Boolean-valued expression | |
input | S | 0..* | DataRequirement | Input data requirements |
output | S | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 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 |
actionId | 1..1 | id | What action is this related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
offset[x] | 0..1 | Time offset for the relationship | ||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | S | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-participantCapabilityStatement | SI | 0..1 | canonical() | What capabilities the device has URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) | |
role | S | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona (extensible) |
definition[x] | 0..1 | canonical(PlanDefinition | Questionnaire | OperationDefinition | EventDefinition) | Description of the activity to be performed | |
action | S | 0..* | Unknown reference to #PlanDefinition.action A sub-action | |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | 1..1 | |||
type | 1..1 | CodeableConcept | Fixed Value: As shown | |
coding | 1..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 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
action | 1..* | BackboneElement | ||
title | 1..1 | string | ||
description | 1..1 | string | ||
code | 1..1 | CodeableConcept | Binding: CPG Common Process (extensible) | |
input | S | 0..* | DataRequirement | |
output | S | 0..* | DataRequirement | |
relatedAction | S | 0..* | BackboneElement | |
participant | 0..* | BackboneElement | ||
cpg-participantCapabilityStatement | S | 0..1 | canonical() | What capabilities the device has URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement |
type | 0..0 | |||
groupingBehavior | 0..0 | |||
selectionBehavior | 0..0 | |||
requiredBehavior | 0..0 | |||
precheckBehavior | 0..0 | |||
cardinalityBehavior | 0..0 | |||
definition[x] | 0..1 | canonical(PlanDefinition | Questionnaire | OperationDefinition | EventDefinition) | ||
transform | 0..0 | |||
dynamicValue | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | I | 1..1 | The definition of a plan for a series of actions, independent of any specific patient or context | |
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the plan definition |
version | SΣ | 1..1 | string | Business version of the plan definition |
name | SΣI | 1..1 | string | Name for this plan definition (computer friendly) |
title | Σ | 1..1 | string | Name for this plan definition (human friendly) |
subtitle | 0..1 | string | Subordinate title of the plan definition | |
type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..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..0 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(http://hl7.org/fhir/R4/group.html) | |||
date | Σ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | SΣ | 1..1 | markdown | Natural language description of the plan definition |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | S | 0..1 | markdown | Why this plan definition is defined |
usage | S | 0..1 | string | Describes the clinical usage of the plan |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the plan definition was approved by publisher |
lastReviewDate | S | 0..1 | date | When the plan definition was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the plan definition is expected to be used |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example) |
author | S | 0..* | ContactDetail | Who authored the content |
editor | S | 0..* | ContactDetail | Who edited the content |
reviewer | S | 0..* | ContactDetail | Who reviewed the content |
endorser | S | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations |
id | 0..1 | string | 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 Binding: RelatedArtifactType (required) |
label | Σ | 0..1 | string | Short label |
display | SΣ | 1..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 1..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | canonical(Resource) | What resource is being referenced |
library | S | 0..1 | canonical(Library) | Logic used by the plan definition |
goal | I | 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) | |
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example) | |
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) | |
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) | |
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example) | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |
target | I | 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) | |
detail[x] | 0..1 | The target value to be achieved | ||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | 0..1 | Duration | Reach goal within | |
action | I | 1..* | 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 |
prefix | S | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | 1..1 | string | User-visible title | |
description | 1..1 | string | Brief description of the action | |
textEquivalent | 0..1 | string | 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) | |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: CPG Common Process (extensible) | |
reason | S | 0..* | CodeableConcept | Why the action should be performed |
documentation | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqf-strengthOfRecommendation | S | 0..1 | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: StrengthOfRecommendationRating (example) | |
cpg-directionOfRecommendation | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation" | |
value[x] | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | ||
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: CPG Recommendation Direction (required) | |
cqf-qualityOfEvidence | S | 0..1 | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: QualityOfEvidenceRating (example) | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) |
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 |
url | Σ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | Σ | 0..1 | canonical(Resource) | What resource is being referenced |
goalId | 0..* | id | What goals this action supports | |
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(http://hl7.org/fhir/R4/group.html) | |||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered |
condition | SI | 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) | |
expression | 0..1 | Expression | Boolean-valued expression | |
input | S | 0..* | DataRequirement | Input data requirements |
output | S | 0..* | DataRequirement | Output data definition |
relatedAction | SI | 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 |
actionId | 1..1 | id | What action is this related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
offset[x] | 0..1 | Time offset for the relationship | ||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | S | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-participantCapabilityStatement | SI | 0..1 | canonical() | What capabilities the device has URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required) | |
role | S | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: CPG Common Persona (extensible) |
definition[x] | 0..1 | canonical(PlanDefinition | Questionnaire | OperationDefinition | EventDefinition) | Description of the activity to be performed | |
action | S | 0..* | Unknown reference to #PlanDefinition.action A sub-action | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
PlanDefinition.language | preferred | CommonLanguages Max Binding: AllLanguages |
PlanDefinition.type | extensible | Fixed Value: workflow-definition("Workflow Definition") |
PlanDefinition.status | required | PublicationStatus |
PlanDefinition.subject[x] | extensible | SubjectType |
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet |
PlanDefinition.topic | example | DefinitionTopic |
PlanDefinition.relatedArtifact.type | required | RelatedArtifactType |
PlanDefinition.goal.category | example | GoalCategory |
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings |
PlanDefinition.goal.priority | preferred | GoalPriority |
PlanDefinition.goal.start | example | GoalStartEvent |
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes |
PlanDefinition.goal.target.measure | example | LOINCCodes |
PlanDefinition.action.priority | required | RequestPriority |
PlanDefinition.action.code | extensible | CPG_Common_Process |
PlanDefinition.action.documentation.extension:strengthOfRecommendation.valueCodeableConcept | example | StrengthOfRecommendationRating |
PlanDefinition.action.documentation.extension:directionOfRecommendation.value[x]:valueCodeableConcept | required | CPG_Recommendation_Direction |
PlanDefinition.action.documentation.extension:qualityOfEvidence.valueCodeableConcept | example | QualityOfEvidenceRating |
PlanDefinition.action.documentation.type | required | RelatedArtifactType |
PlanDefinition.action.subject[x] | extensible | SubjectType |
PlanDefinition.action.condition.kind | required | ActionConditionKind |
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType |
PlanDefinition.action.participant.type | required | ActionParticipantType |
PlanDefinition.action.participant.role | extensible | CPG_Common_Persona |
Id | Path | Details | Requirements |
dom-2 | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | PlanDefinition | If 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-3 | PlanDefinition | If 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-6 | PlanDefinition | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
pdf-0 | PlanDefinition | Name 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-1 | PlanDefinition.goal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.goal.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.action | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.action.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.action.relatedAction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.action.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | PlanDefinition.action.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | PlanDefinition.action.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | PlanDefinition.action.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | PlanDefinition.action.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |