2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile Clinical Quality Framework (CQF) Careplan Profile - Definitions

Todo

Definitions for the cqf-careplan-cqf-careplan Profile.

CarePlan(cqf-careplan)
Definition

Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.

Control1..1
Requirements
Alternate NamesCare Team
Comments
CarePlan.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
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. Bundles always have an id, though it is usually a generated UUID.

CarePlan.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Requirements
Comments
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.

Control0..1
Typeuri
Is Modifiertrue
Requirements
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 as much as possible.

CarePlan.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
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).

CarePlan.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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.

Control0..*
TypeResource
Requirements
Alternate Namesinline 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.

CarePlan.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.identifier
Definition

This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Control0..*
TypeIdentifier
Requirements

Need to allow connection to a wider workflow.

Comments
CarePlan.patient
Definition

Identifies the patient/subject whose intended care is described by the plan.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Must Supporttrue
Requirements

Care plans are associated with the patient the plan is for.

Comments
CarePlan.status
Definition

Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.

Control1..1
BindingIndicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.
The codes SHALL be taken from CarePlanStatus
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments
CarePlan.period
Definition

Indicates when the plan did (or is intended to) come into effect and end.

Control0..1
TypePeriod
Must Supporttrue
Requirements

Allows tracking what plan(s) are in effect at a particular time.

Comments

Any activities scheduled as part of the plan should be constrained to the specified period.

CarePlan.modified
Definition

Identifies the most recent date on which the plan has been revised.

Control0..1
TypedateTime
Requirements

Indicates how current the plan is.

Comments
CarePlan.concern
Definition

Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Condition))
Must Supporttrue
Requirements

Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns.

Comments
CarePlan.participant
Definition

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

Control0..*
Must Supporttrue
Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Alternate NamesCare Team
Comments
CarePlan.participant.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
CarePlan.participant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.participant.role
Definition

Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.

Control0..1
BindingIndicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.
TypeCodeableConcept
Must Supporttrue
Requirements
Comments

Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.

CarePlan.participant.member
Definition

The specific person or organization who is participating/expected to participate in the care plan.

Control1..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Must Supporttrue
Requirements
Comments

Patient only needs to be listed if they have a role other than "subject of care".

CarePlan.goal
Definition

Describes the intended objective(s) of carrying out the Care Plan.

Control0..*
Must Supporttrue
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.

CarePlan.goal.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
CarePlan.goal.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.goal.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.goal.description
Definition

Human-readable description of a specific desired objective of the care plan.

Control1..1
Typestring
Requirements

Without a description of what's trying to be achieved, element has no purpose.

Comments
CarePlan.goal.status
Definition

Indicates whether the goal has been reached and is still considered relevant.

Control0..1
BindingIndicates whether the goal has been met and is still being targeted
The codes SHALL be taken from CarePlanGoalStatus
Typecode
Must Supporttrue
Requirements

Allows measuring outcome and also indicates relevance of goal to plan.

Comments
CarePlan.goal.notes
Definition

Any comments related to the goal.

Control0..1
Typestring
Requirements

There's a need to capture information about the goal that doesn't actually describe the goal.

Comments

May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.

CarePlan.goal.concern
Definition

The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Condition))
Must Supporttrue
Requirements

Allows specific goals to explicitly linked to conditions - makes the plan more understandable.

Comments

The concerns do not also need to be listed under CarePlan.concern, but may be.

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.

Control0..*
Must Supporttrue
Requirements

Allows systems to prompt for performance of planned activities, validate plans against best practice.

Comments
CarePlan.activity.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
CarePlan.activity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.activity.goal
Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Control0..*
Typeuri
Requirements

So that participants know the link explicitly.

Comments
CarePlan.activity.status
Definition

Identifies what progress is being made for the specific activity.

Control0..1
BindingIndicates where the activity is at in its overall life cycle
The codes SHALL be taken from CarePlanActivityStatus
Typecode
Must Supporttrue
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.

CarePlan.activity.prohibited
Definition

If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

Control1..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Requirements

Captures intention to not do something that may have been previously typical.

Comments
CarePlan.activity.actionResulting
Definition

Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.

Control0..*
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
Must Supporttrue
Requirements

Links plan to resulting actions.

Comments
CarePlan.activity.notes
Definition

Notes about the execution of the activity.

Control0..1
Typestring
Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

Doesn't describe the activity - that goes in details.

CarePlan.activity.detail
Definition

The details of the proposed activity represented in a specific resource.

Control0..1 This element is affected by the following invariants: cpl-3
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Procedure)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/MedicationPrescription)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/DiagnosticOrder)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Encounter)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Supply))
Must Supporttrue
Requirements

Details in a form consistent with other applications and contexts of use.

Comments
CarePlan.activity.simple
Definition

A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Control0..1 This element is affected by the following invariants: cpl-3
Must Supporttrue
Requirements

Details in a simple form for generic care plan systems.

Comments
InvariantsDefined on this element
cpl-1: DailyDose can only be specified if activity category is drug or food (xpath: (f:category/@value=('drug','diet')) = exists(f:dailyAmount))
cpl-2: Quantity can only be specified if activity category is supply (xpath: (f:category/@value=('supply')) = exists(f:quantity))
cpl-3: Only provide a detail reference, or a simple detail summary (xpath: not(exists(f:detail)) or not(exists(f:simple)))
CarePlan.activity.simple.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
CarePlan.activity.simple.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.activity.simple.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

CarePlan.activity.simple.category
Definition

High-level categorization of the type of activity in a care plan.

Control1..1
BindingHigh-level categorization of the type of activity in a care plan.
The codes SHALL be taken from CarePlanActivityCategory
Typecode
Must Supporttrue
Requirements

May determine what types of extensions are permitted.

Comments
CarePlan.activity.simple.code
Definition

Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.

Control0..1
BindingDetailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.
TypeCodeableConcept
Must Supporttrue
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.

CarePlan.activity.simple.scheduled[x]
Definition

The period, timing or frequency upon which the described activity is to occur.

Control0..1
TypeChoice of: Timing, Period, string
Must Supporttrue
Requirements

Allows prompting for activities and detection of missed planned activities.

Comments
CarePlan.activity.simple.location
Definition

Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Location))
Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may just identify a type of location.

CarePlan.activity.simple.performer
Definition

Identifies who's expected to be involved in the activity.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Must Supporttrue
Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

CarePlan.activity.simple.product
Definition

Identifies the food, drug or other product being consumed or supplied in the activity.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Medication)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Substance))
Must Supporttrue
Requirements
Comments
CarePlan.activity.simple.dailyAmount
Definition

Identifies the quantity expected to be consumed in a given day.

Control0..1 This element is affected by the following invariants: cpl-1
TypeQuantity
Must Supporttrue
Requirements

Allows rough dose checking.

Alternate Namesdaily dose
Comments
CarePlan.activity.simple.quantity
Definition

Identifies the quantity expected to be supplied.

Control0..1 This element is affected by the following invariants: cpl-2
TypeQuantity
Must Supporttrue
Requirements
Comments
CarePlan.activity.simple.details
Definition

This provides a textual description of constraints on the 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.

Control0..1
Typestring
Requirements
Comments
CarePlan.notes
Definition

General notes about the care plan not covered elsewhere.

Control0..1
Typestring
Requirements

Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.

Comments