Da Vinci - Payer Coverage Decision Exchange (PCDE)
1.0.0 - STU 1

Da Vinci - Payer Coverage Decision Exchange (PCDE), published by HL7 International - Financial Management Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-pcde/ and changes regularly. See the Directory of published versions

## Resource Profile: PCDECarePlan - Detailed Descriptions

Active as of 2022-08-29

Definitions for the profile-careplan resource profile.

1. CarePlan
Definition | The US Core CarePlan Profile is based upon the core FHIR CarePlan Resource and created to meet the 2015 Edition Common Clinical Data Set 'Assessment and Plan of Treatment requirements.
Control | 0..*
Alternate Names | Care Team
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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-4: 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. CarePlan.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | string
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. CarePlan.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. CarePlan.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. CarePlan.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. CarePlan.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1
Type | Narrative
Must Support | true
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. CarePlan.text.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
8. CarePlan.text.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CarePlan.text.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. CarePlan.text.status
Definition | generated | additional.
Control | 1..1
Binding | The codes SHALL be taken from US Core Narrative Status Constrained value set of narrative statuses.
Type | code
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. CarePlan.text.div
Definition | The actual narrative content, a stripped down version of XHTML.
Control | 1..1
Type | xhtml
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (: htmlChecks()) txt-2: The narrative SHALL have some non-whitespace content (: htmlChecks())
11. CarePlan.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
12. CarePlan.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. CarePlan.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. CarePlan.identifier
Definition | Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Requirements | Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. CarePlan.instantiatesCanonical
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Control | 0..*
Type | canonical(ActivityDefinition | Measure | PlanDefinition)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. CarePlan.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Control | 0..*
Type | uri
Must Support | true
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. CarePlan.basedOn
Definition | A care plan that is fulfilled in whole or in part by this care plan.
Control | 0..*
Type | Reference(CarePlan)
Requirements | Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.
Alternate Names | fulfills
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. CarePlan.replaces
Definition | Completed or terminated care plan whose function is taken by this new care plan.
Control | 0..*
Type | Reference(CarePlan)
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.
Alternate Names | supersedes
Comments | The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. CarePlan.partOf
Definition | A larger care plan of which this particular care plan is a component or step.
Control | 0..*
Type | Reference(CarePlan)
Comments | Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. CarePlan.status
Definition | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Control | 1..1
Binding | The codes SHALL be taken from RequestStatus Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Type | code
Is Modifier | true
Must Support | true
Requirements | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Comments | The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.
Fixed Value | active
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. CarePlan.intent
Definition | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
Control | 1..1
Binding | The codes SHALL be taken from CarePlanIntent Codes indicating the degree of authority/intentionality associated with a care plan
Type | code
Is Modifier | true
Must Support | true
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
Fixed Value | plan
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. CarePlan.category
Definition | Type of plan.
Control | 1..*
Binding | For example codes, see CarePlanCategory Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
Type | CodeableConcept
Must Support | true
Requirements | Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
Comments | There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on CarePlan.category. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
23. CarePlan.category:AssessPlan
SliceName | AssessPlan
Definition | Type of plan.
Control | 1..1
Binding | For example codes, see CarePlanCategory Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
Type | CodeableConcept
Must Support | true
Requirements | Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
Comments | There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/core/CodeSystem/careplan-category"/> <code value="assess-plan"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. CarePlan.title
Definition | Human-friendly name for the care plan.
Control | 0..1
Type | string
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. CarePlan.description
Definition | A description of the scope and nature of the plan.
Control | 0..1
Type | string
Requirements | Provides more detail than conveyed by category.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. CarePlan.subject
Definition | Who care plan is for.
Control | 1..1
Type | Reference(USCorePatientProfile)
Must Support | true
Requirements | Identifies the patient or group whose intended care is described by the plan.
Alternate Names | patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. CarePlan.encounter
Definition | The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
Control | 0..1
Type | Reference(Encounter)
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. CarePlan.period
Definition | Indicates when the plan did (or is intended to) come into effect and end.
Control | 0..1
Type | Period
Requirements | Allows tracking what plan(s) are in effect at a particular time.
Alternate Names | timing
Comments | Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. CarePlan.created
Definition | Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
Control | 0..1
Type | dateTime
Alternate Names | authoredOn
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. CarePlan.author
Definition | When populated, the author is responsible for the care plan. The care plan is attributed to the author.
Control | 0..1
Type | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
Comments | The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. CarePlan.contributor
Definition | Identifies the individual(s) or organization who provided the contents of the care plan.
Control | 0..*
Type | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
Comments | Collaborative care plans may have multiple contributors.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. CarePlan.careTeam
Definition | Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Control | 0..*
Type | Reference(CareTeam)
Requirements | Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. CarePlan.addresses
Definition | Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Control | 0..*
Type | Reference(Condition)
Requirements | Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns.
Comments | When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. CarePlan.supportingInfo
Definition | Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Control | 0..*
Type | Reference(Resource)
Requirements | Identifies barriers and other considerations associated with the care plan.
Comments | Use "concern" to identify specific conditions addressed by the care plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. CarePlan.goal
Definition | Describes the intended objective(s) of carrying out the care plan.
Control | 0..*
Type | Reference(Goal)
Requirements | Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.
Comments | Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. CarePlan.activity
Definition | Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
Control | 1..*
Type | BackboneElement
Must Support | true
Requirements | Allows systems to prompt for performance of planned activities, and validate plans against best practice.
Invariants | Defined on this element cpl-3: Provide a reference or detail, not both (: detail.empty() or reference.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. CarePlan.activity.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
38. CarePlan.activity.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. CarePlan.activity.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. CarePlan.activity.outcomeCodeableConcept
Definition | Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
Control | 0..*
Binding | For example codes, see CarePlanActivityOutcome Identifies the results of the activity.
Type | CodeableConcept
Comments | Note that this should not duplicate the activity status (e.g. completed or in progress).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. CarePlan.activity.outcomeReference
Definition | Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).
Control | 0..*
Type | Reference(Resource)
Requirements | Links plan to resulting actions.
Comments | The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. CarePlan.activity.progress
Definition | Notes about the adherence/status/progress of the activity.
Control | 0..*
Type | Annotation
Requirements | Can be used to capture information about adherence, progress, concerns, etc.
Comments | This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. CarePlan.activity.reference
Definition | The details of the proposed activity represented in a specific resource.
Control | 0..1 This element is affected by the following invariants: cpl-3
Type | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)
Requirements | Details in a form consistent with other applications and contexts of use.
Comments | Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. CarePlan.activity.detail
Definition | A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
Control | 1..1 This element is affected by the following invariants: cpl-3
Type | BackboneElement
Must Support | true
Requirements | Details in a simple form for generic care plan systems.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. CarePlan.activity.detail.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
46. CarePlan.activity.detail.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. CarePlan.activity.detail.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
48. CarePlan.activity.detail.kind
Definition | A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
Control | 0..1
Binding | The codes SHALL be taken from CarePlanActivityKind Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
Type | code
Requirements | May determine what types of extensions are permitted.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. CarePlan.activity.detail.instantiatesCanonical
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
Control | 0..*
Type | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. CarePlan.activity.detail.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
Control | 0..*
Type | uri
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. CarePlan.activity.detail.code
Definition | Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
Control | 0..1
Binding | The codes SHALL be taken from PCDE Plan Action; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Requirements | Allows matching performed to planned as well as validation against protocols.
Comments | Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. CarePlan.activity.detail.reasonCode
Definition | Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
Control | 0..*
Binding | The codes SHALL be taken from PCDE Plan Action Reason; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. CarePlan.activity.detail.reasonReference
Definition | Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
Control | 0..*
Type | Reference(USCoreCondition | Observation | USCoreDiagnosticReportProfileLaboratoryReporting | USCoreDiagnosticReportProfileNoteExchange | USCoreDocumentReferenceProfile)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Comments | Conditions can be identified at the activity level that are not identified as reasons for the overall plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. CarePlan.activity.detail.goal
Definition | Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
Control | 0..*
Type | Reference(Goal)
Requirements | So that participants know the link explicitly.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. CarePlan.activity.detail.status
Definition | Identifies what progress is being made for the specific activity.
Control | 1..1
Binding | The codes SHALL be taken from CarePlanActivityStatus Codes that reflect the current state of a care plan activity within its overall life cycle.
Type | code
Is Modifier | true
Must Support | true
Requirements | Indicates progress against the plan, whether the activity is still relevant for the plan.
Comments | Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. CarePlan.activity.detail.statusReason
Definition | Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
Control | 0..1
Type | CodeableConcept
Comments | Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. CarePlan.activity.detail.doNotPerform
Definition | If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
Control | 0..1
Type | boolean
Is Modifier | true
Requirements | Captures intention to not do something that may have been previously typical.
Comments | This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.
Meaning if Missing | If missing indicates that the described activity is one that should be engaged in when following the plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. CarePlan.activity.detail.scheduled[x]
Definition | The period, timing or frequency upon which the described activity is to occur.
Control | 0..1
Type | Choice of: Timing, Period, string
[x] Note | See Choice of Data Types for further information about how to use [x]
Requirements | Allows prompting for activities and detection of missed planned activities.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. CarePlan.activity.detail.location
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
Control | 0..1
Type | Reference(Location)
Requirements | Helps in planning of activity.
Comments | May reference a specific clinical location or may identify a type of location.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. CarePlan.activity.detail.performer
Definition | Identifies who's expected to be involved in the activity.
Control | 0..*
Type | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)
Requirements | Helps in planning of activity.
Comments | A performer MAY also be a participant in the care plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. CarePlan.activity.detail.product[x]
Definition | Identifies the food, drug or other product to be consumed or supplied in the activity.
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationCodes A product supplied or administered as part of a care plan activity.
Type | Choice of: CodeableConcept, Reference(Medication | Substance)
[x] Note | See Choice of Data Types for further information about how to use [x]
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. CarePlan.activity.detail.dailyAmount
Definition | Identifies the quantity expected to be consumed in a given day.
Control | 0..1
Type | Quantity(SimpleQuantity)
Requirements | Allows rough dose checking.
Alternate Names | daily dose
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. CarePlan.activity.detail.quantity
Definition | Identifies the quantity expected to be supplied, administered or consumed by the subject.
Control | 0..1
Type | Quantity(SimpleQuantity)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. CarePlan.activity.detail.description
Definition | This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
Control | 0..1
Type | string
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. CarePlan.note
Definition | General notes about the care plan not covered elsewhere.
Control | 0..*
Type | Annotation
Requirements | Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))