This page is part of the MCC eCare Plan Implementation Guide (v1.0.0-ballot2: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Active as of 2022-04-13 |
Definitions for the mccCarePlan resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. CarePlan | |
2. CarePlan.extension:custodian | |
SliceName | custodian |
Control | 0..1 |
Type | Extension(Custodian) (Extension Type: Reference) |
3. CarePlan.status | |
4. CarePlan.intent | |
5. CarePlan.category | |
6. CarePlan.subject | |
Type | Reference(USCorePatientProfile) |
7. CarePlan.author | |
Definition | Use of CarePlan.author is discouraged. It is removed from the R5 CarePlan Resource and replaced with CarePlan.custodian and should not be used to indicate the responsible party. CarePlan custodian extension should be used to identify a responsible party in the MCC CarePlan Profile When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
8. CarePlan.contributor | |
Definition | CarePlan.contributor SHALL be used to represent contributors to the care plan instead of author in the MCC CarePlan. Contributors can range from devices (e.g. a home BP monitor) to an individual, team or organization Identifies the individual(s) or organization who provided the contents of the care plan. |
Type | Reference(USCorePatientProfile|USCorePractitionerProfile|USCorePractitionerRoleProfile|USCoreCareTeam|USCoreOrganizationProfile|RelatedPerson|Device|MCCCareTeam|Patient|Practitioner|PractitionerRole|Organization|CareTeam) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
9. CarePlan.careTeam | |
Type | Reference(MCCCareTeam|USCoreCareTeam|CareTeam) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
10. CarePlan.addresses | |
Control | 0..? |
11. CarePlan.addresses.reference | |
Control | 0..? |
12. CarePlan.supportingInfo | |
Definition | Identifies portions of the patient's record that specifically influenced the formation of the overall plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. These may be thought of as Health Concerns within the Care Plan context. In the MCC Care Plan, supportingInfo should refer to MCC Profiles. In most cases these profiles are profiles derived from US Core, with additional requirements or guidance for the use of these profiles within a Care Plan. Profiles not specifically referenced may also be used and are not precluded. 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. |
Type | Reference(USCoreBloodPressureProfile|USCoreBMIProfile|USCoreBodyWeightProfile|MCCChronicDisease|MCCLaboratoryResultObservation|MCCDiagnosticReportAndNote|MCCProcedure|USCoreImmunizationProfile|MCCFamilyHistory|DocRefPACP|SDCQuestionnaireResponse|MCCSymptomObservation|MCCServiceRequest|MCCObservationSDOHAssessment|MCCImmunization|MCCNutritionOrder|MCCClinicalImpression|MCCPatientCaregiverConditionStatus|MCCQuestionnaireResponse|MCCCaregiverConsiderationsObservation|MCCClinicalResultObservation|USCoreRelatedPersonProfile|USCoreObservationOccupationProfile|Resource) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
13. CarePlan.goal | |
Definition | Describes the intended objective(s) of carrying out the care plan. In the MCC Care Plan, CarePlan.goal When used US Core Goal should be used. Describes the intended objective(s) of carrying out the care plan. |
Type | Reference(MCCGoal|Goal) |
14. CarePlan.activity | |
Must Support | true |
15. CarePlan.activity.outcomeReference | |
Definition | This element details 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 the CarePlan.activity.reference (a reference to a “request” resource). In the MCC Care Plan, CarePlan.activity.OutcomeReference (Must Support) is preferred over outcomeCodeableConcept. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.outcomeReference. Please also see the Care Plan Profile Relationship diagram for additional guidance <link?>. There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference of activity.outcomeReference for details. 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). |
Type | Reference(MCCProcedure|MCCLaboratoryResultObservation|USCoreImmunizationProfile|MCCDiagnosticReportAndNote|USCoreImmunizationProfile|MCCMedicationRequest|MCCChronicDisease|USCoreBodyWeightProfile|USCoreBloodPressureProfile|MCCGoal|USCoreBMIProfile|MCCSymptomObservation|Resource) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
16. CarePlan.activity.reference | |
Definition | This CarePlan element holds the details of the proposed activity represented in a specific resource. Planned activities represent ordered or planned activities that are part of the Care Plan. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.reference. The referred to profiles are suggested for use within the MCC Care Plan, but additional ServiceRequest may be used. When US Core R5 is published. US Core Service Request will be used and may be profiled to add additional requirements for when serviceRequest is used within a FHIR Care Plan There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference for activity.reference to provide details. The details of the proposed activity represented in a specific resource. |
Type | Reference(NutritionOrder|MCCMedicationRequest|CommunicationRequest|DeviceRequest|Task|ServiceRequest|VisionPrescription|RequestGroup|Appointment|MedicationRequest) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
17. CarePlan.activity.detail | |
Control | 0..01 |
Guidance on how to interpret the contents of this table can be found here.
1. CarePlan | |
Definition | - Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. |
Control | 0..* |
Summary | false |
Alternate Names | Care Team |
Comments | - |
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.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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | 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())) |
3. 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 | 0..1 |
Type | Narrative |
Must Support | true |
Summary | false |
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())) |
4. CarePlan.text.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Control | 1..1 |
Binding | The codes SHALL be taken from US Core Narrative StatusThe codes SHALL be taken from NarrativeStatus Constrained value set of narrative statuses. The status of a resource narrative. |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. CarePlan.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Control | 1..1 |
Type | xhtml |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
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()) |
6. CarePlan.extension:custodian | |
SliceName | custodian |
Definition | When populated, the custodian is responsible for the care and maintenance of the care plan. The care plan is attributed to the custodian. The custodian might or might not be a contributor. This CarePlan.custodian extension should be used instead of CarePlan.author which in R4 is currently identified as the designated responsible party and in R5 has been removed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Custodian) (Extension Type: Reference) |
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()) |
7. 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 |
Summary | false |
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()) |
8. 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Allows clinicians to determine whether the plan is actionable or not. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. 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 Codes indicating the degree of authority/intentionality associated with a care plan. |
Type | code |
Is Modifier | true |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. CarePlan.category | |
Definition | Type of plan. 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. |
Control | 10..* |
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 |
Summary | 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. Used for filtering what plan(s) are retrieved and displayed to different types of users. |
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:
|
11. CarePlan.category:AssessPlan | |
SliceName | AssessPlan |
Definition | Type of plan. 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. |
Control | 10..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 |
Summary | 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. Used for filtering what plan(s) are retrieved and displayed to different types of users. |
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())) |
12. CarePlan.subject | |
Definition | Who care plan is for. Identifies the patient or group whose intended care is described by the plan. |
Control | 1..1 |
Type | Reference(USCorePatientProfile|Patient|Group) |
Must Support | true |
Summary | 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())) |
13. CarePlan.author | |
Definition | Use of CarePlan.author is discouraged. It is removed from the R5 CarePlan Resource and replaced with CarePlan.custodian and should not be used to indicate the responsible party. CarePlan custodian extension should be used to identify a responsible party in the MCC CarePlan Profile 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) |
Summary | true |
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())) |
14. CarePlan.contributor | |
Definition | CarePlan.contributor SHALL be used to represent contributors to the care plan instead of author in the MCC CarePlan. Contributors can range from devices (e.g. a home BP monitor) to an individual, team or organization Identifies the individual(s) or organization who provided the contents of the care plan. |
Control | 0..* |
Type | Reference(USCorePatientProfile|USCorePractitionerProfile|USCorePractitionerRoleProfile|USCoreCareTeam|USCoreOrganizationProfile|RelatedPerson|Device|MCCCareTeam|Patient|Practitioner|PractitionerRole|Organization|CareTeam) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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())) |
15. 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(MCCCareTeam|USCoreCareTeam|CareTeam) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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())) |
16. CarePlan.supportingInfo | |
Definition | Identifies portions of the patient's record that specifically influenced the formation of the overall plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. These may be thought of as Health Concerns within the Care Plan context. In the MCC Care Plan, supportingInfo should refer to MCC Profiles. In most cases these profiles are profiles derived from US Core, with additional requirements or guidance for the use of these profiles within a Care Plan. Profiles not specifically referenced may also be used and are not precluded. 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(USCoreBloodPressureProfile|USCoreBMIProfile|USCoreBodyWeightProfile|MCCChronicDisease|MCCLaboratoryResultObservation|MCCDiagnosticReportAndNote|MCCProcedure|USCoreImmunizationProfile|MCCFamilyHistory|DocRefPACP|SDCQuestionnaireResponse|MCCSymptomObservation|MCCServiceRequest|MCCObservationSDOHAssessment|MCCImmunization|MCCNutritionOrder|MCCClinicalImpression|MCCPatientCaregiverConditionStatus|MCCQuestionnaireResponse|MCCCaregiverConsiderationsObservation|MCCClinicalResultObservation|USCoreRelatedPersonProfile|USCoreObservationOccupationProfile|Resource) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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())) |
17. CarePlan.goal | |
Definition | Describes the intended objective(s) of carrying out the care plan. In the MCC Care Plan, CarePlan.goal When used US Core Goal should be used. Describes the intended objective(s) of carrying out the care plan. |
Control | 0..* |
Type | Reference(MCCGoal|Goal) |
Summary | false |
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())) |
18. 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 | 0..* |
Type | BackboneElement |
Must Support | true |
Summary | false |
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())) |
19. 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 |
Summary | 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()) |
20. CarePlan.activity.outcomeReference | |
Definition | This element details 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 the CarePlan.activity.reference (a reference to a “request” resource). In the MCC Care Plan, CarePlan.activity.OutcomeReference (Must Support) is preferred over outcomeCodeableConcept. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.outcomeReference. Please also see the Care Plan Profile Relationship diagram for additional guidance <link?>. There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference of activity.outcomeReference for details. 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(MCCProcedure|MCCLaboratoryResultObservation|USCoreImmunizationProfile|MCCDiagnosticReportAndNote|USCoreImmunizationProfile|MCCMedicationRequest|MCCChronicDisease|USCoreBodyWeightProfile|USCoreBloodPressureProfile|MCCGoal|USCoreBMIProfile|MCCSymptomObservation|Resource) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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())) |
21. CarePlan.activity.reference | |
Definition | This CarePlan element holds the details of the proposed activity represented in a specific resource. Planned activities represent ordered or planned activities that are part of the Care Plan. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.reference. The referred to profiles are suggested for use within the MCC Care Plan, but additional ServiceRequest may be used. When US Core R5 is published. US Core Service Request will be used and may be profiled to add additional requirements for when serviceRequest is used within a FHIR Care Plan There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference for activity.reference to provide details. 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(NutritionOrder|MCCMedicationRequest|CommunicationRequest|DeviceRequest|Task|ServiceRequest|VisionPrescription|RequestGroup|Appointment|MedicationRequest) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. 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 | 0..01 This element is affected by the following invariants: cpl-3 |
Type | BackboneElement |
Summary | false |
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())) |
Guidance on how to interpret the contents of this table can be found here.
1. CarePlan | |||||
Definition | - | ||||
Control | 0..* | ||||
Summary | false | ||||
Alternate Names | Care Team | ||||
Comments | - | ||||
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 | id | ||||
Summary | true | ||||
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 | ||||
Summary | true | ||||
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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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 | 0..1 | ||||
Type | Narrative | ||||
Must Support | true | ||||
Summary | false | ||||
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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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 | ||||
Summary | false | ||||
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:
| ||||
9. CarePlan.text.status | |||||
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from US Core Narrative Status Constrained value set of narrative statuses | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
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 | ||||
Summary | false | ||||
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 | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
13. CarePlan.extension:custodian | |||||
SliceName | custodian | ||||
Definition | When populated, the custodian is responsible for the care and maintenance of the care plan. The care plan is attributed to the custodian. The custodian might or might not be a contributor. This CarePlan.custodian extension should be used instead of CarePlan.author which in R4 is currently identified as the designated responsible party and in R5 has been removed. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Custodian) (Extension Type: Reference) | ||||
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.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 | ||||
Summary | false | ||||
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()) | ||||
15. 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 | ||||
Summary | true | ||||
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())) | ||||
16. 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(PlanDefinition|Questionnaire|Measure|ActivityDefinition|OperationDefinition) | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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())) | ||||
18. CarePlan.basedOn | |||||
Definition | A care plan that is fulfilled in whole or in part by this care plan. | ||||
Control | 0..* | ||||
Type | Reference(CarePlan) | ||||
Summary | true | ||||
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())) | ||||
19. CarePlan.replaces | |||||
Definition | Completed or terminated care plan whose function is taken by this new care plan. | ||||
Control | 0..* | ||||
Type | Reference(CarePlan) | ||||
Summary | true | ||||
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())) | ||||
20. CarePlan.partOf | |||||
Definition | A larger care plan of which this particular care plan is a component or step. | ||||
Control | 0..* | ||||
Type | Reference(CarePlan) | ||||
Summary | true | ||||
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())) | ||||
21. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. 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 pla | ||||
Type | code | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. 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 | ||||
Summary | 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:
| ||||
24. 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 | ||||
Summary | 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())) | ||||
25. CarePlan.title | |||||
Definition | Human-friendly name for the care plan. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. CarePlan.description | |||||
Definition | A description of the scope and nature of the plan. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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())) | ||||
27. CarePlan.subject | |||||
Definition | Who care plan is for. | ||||
Control | 1..1 | ||||
Type | Reference(USCorePatientProfile) | ||||
Must Support | true | ||||
Summary | 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())) | ||||
28. 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) | ||||
Summary | true | ||||
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())) | ||||
29. CarePlan.period | |||||
Definition | Indicates when the plan did (or is intended to) come into effect and end. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
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())) | ||||
30. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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())) | ||||
31. CarePlan.author | |||||
Definition | Use of CarePlan.author is discouraged. It is removed from the R5 CarePlan Resource and replaced with CarePlan.custodian and should not be used to indicate the responsible party. CarePlan custodian extension should be used to identify a responsible party in the MCC CarePlan Profile | ||||
Control | 0..1 | ||||
Type | Reference(Patient|Practitioner|PractitionerRole|Device|RelatedPerson|Organization|CareTeam) | ||||
Summary | true | ||||
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())) | ||||
32. CarePlan.contributor | |||||
Definition | CarePlan.contributor SHALL be used to represent contributors to the care plan instead of author in the MCC CarePlan. Contributors can range from devices (e.g. a home BP monitor) to an individual, team or organization | ||||
Control | 0..* | ||||
Type | Reference(USCorePatientProfile|USCorePractitionerProfile|USCorePractitionerRoleProfile|USCoreCareTeam|USCoreOrganizationProfile|RelatedPerson|Device|MCCCareTeam) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
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())) | ||||
33. 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(MCCCareTeam|USCoreCareTeam) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
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())) | ||||
34. 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) | ||||
Summary | true | ||||
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())) | ||||
35. CarePlan.addresses.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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
36. CarePlan.addresses.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 | ||||
Summary | false | ||||
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.addresses.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
37. CarePlan.addresses.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. CarePlan.addresses.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. CarePlan.addresses.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. CarePlan.addresses.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. CarePlan.supportingInfo | |||||
Definition | Identifies portions of the patient's record that specifically influenced the formation of the overall plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. These may be thought of as Health Concerns within the Care Plan context. In the MCC Care Plan, supportingInfo should refer to MCC Profiles. In most cases these profiles are profiles derived from US Core, with additional requirements or guidance for the use of these profiles within a Care Plan. Profiles not specifically referenced may also be used and are not precluded. | ||||
Control | 0..* | ||||
Type | Reference(USCoreBloodPressureProfile|USCoreBMIProfile|USCoreBodyWeightProfile|MCCChronicDisease|MCCLaboratoryResultObservation|MCCDiagnosticReportAndNote|MCCProcedure|USCoreImmunizationProfile|MCCFamilyHistory|DocRefPACP|SDCQuestionnaireResponse|MCCSymptomObservation|MCCServiceRequest|MCCObservationSDOHAssessment|MCCImmunization|MCCNutritionOrder|MCCClinicalImpression|MCCPatientCaregiverConditionStatus|MCCQuestionnaireResponse|MCCCaregiverConsiderationsObservation|MCCClinicalResultObservation|USCoreRelatedPersonProfile|USCoreObservationOccupationProfile) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
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())) | ||||
42. CarePlan.goal | |||||
Definition | Describes the intended objective(s) of carrying out the care plan. In the MCC Care Plan, CarePlan.goal When used US Core Goal should be used. | ||||
Control | 0..* | ||||
Type | Reference(MCCGoal) | ||||
Summary | false | ||||
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())) | ||||
43. 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 | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | false | ||||
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())) | ||||
44. 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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
45. 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 | ||||
Summary | false | ||||
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()) | ||||
46. 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 | ||||
Summary | 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()) | ||||
47. 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 | ||||
Summary | false | ||||
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())) | ||||
48. CarePlan.activity.outcomeReference | |||||
Definition | This element details 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 the CarePlan.activity.reference (a reference to a “request” resource). In the MCC Care Plan, CarePlan.activity.OutcomeReference (Must Support) is preferred over outcomeCodeableConcept. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.outcomeReference. Please also see the Care Plan Profile Relationship diagram for additional guidance <link?>. There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference of activity.outcomeReference for details. | ||||
Control | 0..* | ||||
Type | Reference(MCCProcedure|MCCLaboratoryResultObservation|USCoreImmunizationProfile|MCCDiagnosticReportAndNote|USCoreImmunizationProfile|MCCMedicationRequest|MCCChronicDisease|USCoreBodyWeightProfile|USCoreBloodPressureProfile|MCCGoal|USCoreBMIProfile|MCCSymptomObservation) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
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())) | ||||
49. CarePlan.activity.progress | |||||
Definition | Notes about the adherence/status/progress of the activity. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Summary | false | ||||
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())) | ||||
50. CarePlan.activity.reference | |||||
Definition | This CarePlan element holds the details of the proposed activity represented in a specific resource. Planned activities represent ordered or planned activities that are part of the Care Plan. Please see the libraries of available value sets pertinent for use with the appropriate Multiple Chronic Condition Care Plan Profile for use within the referenced profiles at CarePlan.activity.reference. The referred to profiles are suggested for use within the MCC Care Plan, but additional ServiceRequest may be used. When US Core R5 is published. US Core Service Request will be used and may be profiled to add additional requirements for when serviceRequest is used within a FHIR Care Plan There is an existing Ticket FHIR- 26064 (https://jira.hl7.org/browse/FHIR-26064) with respect to clarifying the description and names for activity within Care Plan applied in R5: 1. Rename: activity.outcome to performedActivity, 2. Rename: activity.reference to plannedActivityReference. The R5 CarePlan does not have activity.detail, accordingly the MCC CarePlan prefers the use of the targeted reference for activity.reference to provide details. | ||||
Control | 0..1 This element is affected by the following invariants: cpl-3 | ||||
Type | Reference(NutritionOrder|MCCMedicationRequest|CommunicationRequest|DeviceRequest|Task|ServiceRequest|VisionPrescription|RequestGroup|Appointment) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
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. | ||||
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 | |||||
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 | 0..0 This element is affected by the following invariants: cpl-3 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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())) | ||||
52. CarePlan.note | |||||
Definition | General notes about the care plan not covered elsewhere. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Summary | false | ||||
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())) |