Status: DRAFT: For Review

Introduction

This profile sets out the expectations for the interweave carePlan resource. We use the CarePlan structure definition as a base to this profile.

Mandatory fields

The following mandatory fields are defined:

1. status - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Thus, allowing clinicians to determine whether the plan is actionable or not.

2. intent - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

3. Subject - every CarePlan must be linked to a Patient (not a Group).

Must Support fields

In addition the following fields are "Must Support" – i.e., they must be populated if relevant and known.

1. Identifier - a Local Id should be provided, such that could be quoted if manually getting in touch to find out more

2. category - 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.

3. encounter - a link to the Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. 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.

4. created - when this particular CarePlan record was created in the system.

Optional fields

Other fields are optional and may be populated if known – on the understanding that not all data consumers will necessarily make use of them. Points of note include:

• basedOn - A care plan that is fulfilled in whole or in part by this care plan. This allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

• replaces - Completed or terminated care plan whose function is taken by/ supersedes this new care plan. This allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

• title - Human-friendly name for the care plan.

• description - A description of the scope and nature of the plan. It provides more detail than conveyed by category.

• addresses - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. It 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.

• activity - 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.

Discouraged or Removed fields

• supportingInfo - removed to avoid unnecessary hierarchy complexity.

• contributor - removed.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for identifier		0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	S	0..1	Identifier	External Ids for this plan
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	S	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
instantiatesCanonical		0..0
instantiatesUri		0..0
category	S	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
subject	S	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
encounter	S	0..1	Reference(InterweaveEncounter)	Encounter created as part of
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		0..1	string	If relevant, description of the referenced resource
period
start	S	0..1	dateTime	Starting time with inclusive boundary
created	S	0..1	dateTime	Date record was first recorded
contributor		0..0
supportingInfo		0..0
activity
detail	S	0..1	BackboneElement	In-line definition of activity
instantiatesCanonical		0..0
instantiatesUri		0..0
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣ	0..1	Identifier	External Ids for this plan
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	SΣ	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	SΣ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
subject	SΣ	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Encounter created as part of
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	0..1	string	If relevant, description of the referenced resource
period	Σ	0..1	Period	Time period plan covers
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
created	SΣ	0..1	dateTime	Date record was first recorded
activity	C	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	SC	0..1	BackboneElement	In-line definition of activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
status	?!	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
CarePlan.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
CarePlan.activity.detail.status	required	CarePlanActivityStatus http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣ	0..1	Identifier	External Ids for this plan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	SΣ	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	SΣ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	SΣ	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Encounter created as part of
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	0..1	string	If relevant, description of the referenced resource
period	Σ	0..1	Period	Time period plan covers
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
created	SΣ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeCodeableConcept		0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress		0..*	Annotation	Comments about the activity status/progress
reference	C	0..1	Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)	Activity details defined in specific resource
detail	SC	0..1	BackboneElement	In-line definition of activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		0..1	code	Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
code		0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why activity is needed
goal		0..*	Reference(Goal)	Goals this activity relates to
status	?!	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
statusReason		0..1	CodeableConcept	Reason for current status
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
scheduled[x]		0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location		0..1	Reference(Location)	Where it should happen
performer		0..*	Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)	Who will be responsible?
product[x]		0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
productCodeableConcept			CodeableConcept
productReference			Reference(Medication | Substance)
dailyAmount		0..1	SimpleQuantity	How to consume/day?
quantity		0..1	SimpleQuantity	How much to administer/supply/consume
description		0..1	string	Extra info describing activity to perform
note		0..*	Annotation	Comments about the plan
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
CarePlan.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CarePlan.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CarePlan.encounter.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CarePlan.activity.outcomeCodeableConcept	example	CarePlanActivityOutcome http://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard
CarePlan.activity.detail.kind	required	CarePlanActivityKind http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 from the FHIR Standard
CarePlan.activity.detail.code	example	ProcedureCodes(SNOMEDCT) http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
CarePlan.activity.detail.status	required	CarePlanActivityStatus http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for identifier		0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	S	0..1	Identifier	External Ids for this plan
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	S	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
instantiatesCanonical		0..0
instantiatesUri		0..0
category	S	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
subject	S	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
encounter	S	0..1	Reference(InterweaveEncounter)	Encounter created as part of
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		0..1	string	If relevant, description of the referenced resource
period
start	S	0..1	dateTime	Starting time with inclusive boundary
created	S	0..1	dateTime	Date record was first recorded
contributor		0..0
supportingInfo		0..0
activity
detail	S	0..1	BackboneElement	In-line definition of activity
instantiatesCanonical		0..0
instantiatesUri		0..0
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣ	0..1	Identifier	External Ids for this plan
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	SΣ	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	SΣ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
subject	SΣ	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Encounter created as part of
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	0..1	string	If relevant, description of the referenced resource
period	Σ	0..1	Period	Time period plan covers
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
created	SΣ	0..1	dateTime	Date record was first recorded
activity	C	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	SC	0..1	BackboneElement	In-line definition of activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
status	?!	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
CarePlan.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
CarePlan.activity.detail.status	required	CarePlanActivityStatus http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	External Ids for this plan Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣ	0..1	Identifier	External Ids for this plan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-carePlan-identifier
value	SΣ	1..1	string	The Local carePlan Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	SΣ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (preferred)
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	SΣ	1..1	Reference(InterweavePatient)	The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
encounter	SΣ	0..1	Reference(InterweaveEncounter)	Encounter created as part of
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	0..1	string	If relevant, description of the referenced resource
period	Σ	0..1	Period	Time period plan covers
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
created	SΣ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeCodeableConcept		0..*	CodeableConcept	Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
progress		0..*	Annotation	Comments about the activity status/progress
reference	C	0..1	Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)	Activity details defined in specific resource
detail	SC	0..1	BackboneElement	In-line definition of activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		0..1	code	Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
code		0..1	CodeableConcept	Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
reasonCode		0..*	CodeableConcept	Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (preferred)
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why activity is needed
goal		0..*	Reference(Goal)	Goals this activity relates to
status	?!	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
statusReason		0..1	CodeableConcept	Reason for current status
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
scheduled[x]		0..1		When activity is to occur
scheduledTiming			Timing
scheduledPeriod			Period
scheduledString			string
location		0..1	Reference(Location)	Where it should happen
performer		0..*	Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)	Who will be responsible?
product[x]		0..1		What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
productCodeableConcept			CodeableConcept
productReference			Reference(Medication | Substance)
dailyAmount		0..1	SimpleQuantity	How to consume/day?
quantity		0..1	SimpleQuantity	How much to administer/supply/consume
description		0..1	string	Extra info describing activity to perform
note		0..*	Annotation	Comments about the plan
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CarePlan.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
CarePlan.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CarePlan.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CarePlan.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	preferred	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard
CarePlan.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CarePlan.encounter.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CarePlan.activity.outcomeCodeableConcept	example	CarePlanActivityOutcome http://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard
CarePlan.activity.detail.kind	required	CarePlanActivityKind http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 from the FHIR Standard
CarePlan.activity.detail.code	example	ProcedureCodes(SNOMEDCT) http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard
CarePlan.activity.detail.reasonCode	preferred	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
CarePlan.activity.detail.status	required	CarePlanActivityStatus http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CarePlan

Summary

Mandatory: 2 elements(9 nested mandatory elements)
Must-Support: 19 elements
Fixed: 3 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

• InterweaveOrganization (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Organization)
• InterweavePatient (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Patient)
• InterweaveEncounter (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Encounter)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CarePlan.meta.tag
• The element 1 is sliced based on the value of CarePlan.identifier