ICARE\Care Plan with Review

CodeX Implementation Guide: ICAREdata - Local Development build (v1.0.0). See the Directory of published versions

StructureDefinition: CarePlanWithReview

An extended Care Plan that includes clinical reviews and documentation of changes. The Care Plan itself describes 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. The Care Plan tracks the progress of activities associated with the plan. The review extension includes the practitioner doing the review, date of review, whether the plan was changed, a coded reason for change, and a narrative describing the change.

The official URL for this profile is:

http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-with-review

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from CarePlan

Summary

Must-Support: 1 element

Extensions

This structure refers to these extensions:

http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan
extension		0..*	Extension	Slice: Unordered, Open by value:url
icare-care-plan-review	S	0..*	(Complex)	Extension URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CarePlan	I	0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
icare-care-plan-review	SI	0..*	(Complex)	Optional Extensions Element URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	External Ids for this plan
instantiatesCanonical	ΣI	0..*	canonical(PlanDefinition \| Questionnaire \| Measure \| ActivityDefinition \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	ΣI	0..*	uri	Instantiates external protocol or definition
basedOn	ΣI	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	ΣI	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	ΣI	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!ΣI	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required)
intent	?!ΣI	1..1	code	proposal \| plan \| order \| option Binding: CarePlanIntent (required)
category	ΣI	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (example)
title	ΣI	0..1	string	Human-friendly name for the care plan
description	ΣI	0..1	string	Summary of nature of plan
subject	ΣI	1..1	Reference(Patient \| Group)	Who the care plan is for
encounter	ΣI	0..1	Reference(Encounter)	Encounter created as part of
period	ΣI	0..1	Period	Time period plan covers
created	ΣI	0..1	dateTime	Date record was first recorded
author	ΣI	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who is the designated responsible party
contributor	I	0..*	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who provided the content of the care plan
careTeam	I	0..*	Reference(CareTeam)	Who's involved in plan?
addresses	ΣI	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo	I	0..*	Reference(Resource)	Information considered as part of plan
goal	I	0..*	Reference(Goal)	Desired outcome of plan
activity	I	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeCodeableConcept	I	0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example)
outcomeReference	I	0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress	I	0..*	Annotation	Comments about the activity status/progress
reference	I	0..1	Reference(Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription \| RequestGroup)	Activity details defined in specific resource
detail	I	0..1	BackboneElement	In-line definition of activity
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind	I	0..1	code	Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription Binding: CarePlanActivityKind (required)
instantiatesCanonical	I	0..*	canonical(PlanDefinition \| ActivityDefinition \| Questionnaire \| Measure \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	I	0..*	uri	Instantiates external protocol or definition
code	I	0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example)
reasonCode	I	0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example)
reasonReference	I	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why activity is needed
goal	I	0..*	Reference(Goal)	Goals this activity relates to
status	?!I	1..1	code	not-started \| scheduled \| in-progress \| on-hold \| completed \| cancelled \| stopped \| unknown \| entered-in-error Binding: CarePlanActivityStatus (required)
statusReason	I	0..1	CodeableConcept	Reason for current status
doNotPerform	?!I	0..1	boolean	If true, activity is prohibiting action
scheduled[x]	I	0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location	I	0..1	Reference(Location)	Where it should happen
performer	I	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| RelatedPerson \| Patient \| CareTeam \| HealthcareService \| Device)	Who will be responsible?
product[x]	I	0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example)
productCodeableConcept			CodeableConcept
productReference			Reference(Medication \| Substance)
dailyAmount	I	0..1	SimpleQuantity	How to consume/day?
quantity	I	0..1	SimpleQuantity	How much to administer/supply/consume
description	I	0..1	string	Extra info describing activity to perform
note	I	0..*	Annotation	Comments about the plan
Documentation for this format

This structure is derived from CarePlan

Summary

Must-Support: 1 element

Extensions

This structure refers to these extensions:

http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan
extension		0..*	Extension	Slice: Unordered, Open by value:url
icare-care-plan-review	S	0..*	(Complex)	Extension URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CarePlan	I	0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
icare-care-plan-review	SI	0..*	(Complex)	Optional Extensions Element URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/icare-care-plan-review
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	External Ids for this plan
instantiatesCanonical	ΣI	0..*	canonical(PlanDefinition \| Questionnaire \| Measure \| ActivityDefinition \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	ΣI	0..*	uri	Instantiates external protocol or definition
basedOn	ΣI	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	ΣI	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	ΣI	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!ΣI	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required)
intent	?!ΣI	1..1	code	proposal \| plan \| order \| option Binding: CarePlanIntent (required)
category	ΣI	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (example)
title	ΣI	0..1	string	Human-friendly name for the care plan
description	ΣI	0..1	string	Summary of nature of plan
subject	ΣI	1..1	Reference(Patient \| Group)	Who the care plan is for
encounter	ΣI	0..1	Reference(Encounter)	Encounter created as part of
period	ΣI	0..1	Period	Time period plan covers
created	ΣI	0..1	dateTime	Date record was first recorded
author	ΣI	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who is the designated responsible party
contributor	I	0..*	Reference(Patient \| Practitioner \| PractitionerRole \| Device \| RelatedPerson \| Organization \| CareTeam)	Who provided the content of the care plan
careTeam	I	0..*	Reference(CareTeam)	Who's involved in plan?
addresses	ΣI	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo	I	0..*	Reference(Resource)	Information considered as part of plan
goal	I	0..*	Reference(Goal)	Desired outcome of plan
activity	I	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeCodeableConcept	I	0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example)
outcomeReference	I	0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress	I	0..*	Annotation	Comments about the activity status/progress
reference	I	0..1	Reference(Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription \| RequestGroup)	Activity details defined in specific resource
detail	I	0..1	BackboneElement	In-line definition of activity
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind	I	0..1	code	Appointment \| CommunicationRequest \| DeviceRequest \| MedicationRequest \| NutritionOrder \| Task \| ServiceRequest \| VisionPrescription Binding: CarePlanActivityKind (required)
instantiatesCanonical	I	0..*	canonical(PlanDefinition \| ActivityDefinition \| Questionnaire \| Measure \| OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	I	0..*	uri	Instantiates external protocol or definition
code	I	0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example)
reasonCode	I	0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example)
reasonReference	I	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why activity is needed
goal	I	0..*	Reference(Goal)	Goals this activity relates to
status	?!I	1..1	code	not-started \| scheduled \| in-progress \| on-hold \| completed \| cancelled \| stopped \| unknown \| entered-in-error Binding: CarePlanActivityStatus (required)
statusReason	I	0..1	CodeableConcept	Reason for current status
doNotPerform	?!I	0..1	boolean	If true, activity is prohibiting action
scheduled[x]	I	0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location	I	0..1	Reference(Location)	Where it should happen
performer	I	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| RelatedPerson \| Patient \| CareTeam \| HealthcareService \| Device)	Who will be responsible?
product[x]	I	0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example)
productCodeableConcept			CodeableConcept
productReference			Reference(Medication \| Substance)
dailyAmount	I	0..1	SimpleQuantity	How to consume/day?
quantity	I	0..1	SimpleQuantity	How much to administer/supply/consume
description	I	0..1	string	Extra info describing activity to perform
note	I	0..*	Annotation	Comments about the plan
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
CarePlan.language	preferred	CommonLanguages Max Binding: AllLanguages
CarePlan.status	required	RequestStatus
CarePlan.intent	required	CarePlanIntent
CarePlan.category	example	CarePlanCategory
CarePlan.activity.outcomeCodeableConcept	example	CarePlanActivityOutcome
CarePlan.activity.detail.kind	required	CarePlanActivityKind
CarePlan.activity.detail.code	example	ProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCode	example	SNOMEDCTClinicalFindings
CarePlan.activity.detail.status	required	CarePlanActivityStatus
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Path	Details	Requirements
dom-2	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	CarePlan	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	CarePlan	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	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	CarePlan.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.extension:carePlanReview	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.extension:carePlanReview	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.replaces	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.intent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.title	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.created	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.author	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.contributor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.careTeam	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.addresses	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.supportingInfo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.goal	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
cpl-3	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
ele-1	CarePlan.activity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.activity.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.activity.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.activity.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.activity.outcomeCodeableConcept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.outcomeReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.progress	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.reference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.activity.detail.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.activity.detail.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CarePlan.activity.detail.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CarePlan.activity.detail.kind	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.goal	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.doNotPerform	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.scheduled[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.product[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.dailyAmount	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.quantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.activity.detail.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CarePlan.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())