This page is part of the Data Exchange Profiles for 2022 CDC Clinical Practice Guideline for Prescribing Opioids (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: Pain Treatment CarePlan Profile

Specifies the essential criteria for representing a pain treatment plan. Ideally the plan should maximize use of nonpharmacologic and nonopioid pharmacologic therapies as appropriate for the specific condition and patient and only consider initiating opioid therapy if expected benefits for pain and function are anticipated to outweigh risks to the patient.

Usages:

• Examples for this Profile: CarePlan/pain-treatment

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	0..1	Narrative	(USCDI) Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements
status	S	1..1	code	(USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
div	SC	1..1	xhtml	(USCDI) Limited xhtml content Constraints: txt-1, txt-2
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣC	1..1	code	(USCDI) 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. Constraints: pt-careplan-status-allowed
intent	?!SΣ	1..1	code	(USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Slices for category	SΣ	1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: Pain treatment plan (required)
category:AssessPlan	SΣ	1..1	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: CarePlanCategory (preferred): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: assess-plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(QICore Patient)	(QI-Core)(USCDI) Who the care plan is for.
created	SΣ	1..1	dateTime	Date record was first recorded
author	SΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CarePlan.text.status	required	NarrativeStatus http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG
CarePlan.category:AssessPlan	preferred	Pattern Value: assess-plan http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'
txt-1	error	CarePlan.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	CarePlan.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from QICoreCarePlan

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
status	C	1..1	code	(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Constraints: pt-careplan-status-allowed
category		1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: Pain treatment plan (required)
created	S	1..1	dateTime	Date record was first recorded
author	S	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	S	0..1	Narrative	(USCDI) Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
status	S	1..1	code	(USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
div	SC	1..1	xhtml	(USCDI) Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!SΣC	1..1	code	(USCDI) 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. Constraints: pt-careplan-status-allowed
intent	?!SΣ	1..1	code	(USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Slices for category	SΣ	1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: Pain treatment plan (required)
category:AssessPlan	SΣ	1..1	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: CarePlanCategory (preferred): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: assess-plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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(QICore Patient)	(QI-Core)(USCDI) Who the care plan is for.
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Time period plan covers
created	SΣ	1..1	dateTime	Date record was first recorded
author	SΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
contributor		0..*	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who provided the content of the care plan
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo		0..*	Reference(Resource)	Information considered as part of plan
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	0..*	BackboneElement	Action to occur as part of plan Constraints: cpl-3
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	C	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.
instantiatesCanonical		0..*	canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..*	uri	Instantiates external protocol or definition
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 (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
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 / Code	URI
CarePlan.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CarePlan.text.status	required	NarrativeStatus http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG
CarePlan.category:AssessPlan	preferred	Pattern Value: assess-plan http://hl7.org/fhir/ValueSet/care-plan-category 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	example	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()
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'
txt-1	error	CarePlan.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	CarePlan.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from QICoreCarePlan

Summary

Mandatory: 1 element
Must-Support: 2 elements

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	0..1	Narrative	(USCDI) Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements
status	S	1..1	code	(USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
div	SC	1..1	xhtml	(USCDI) Limited xhtml content Constraints: txt-1, txt-2
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣC	1..1	code	(USCDI) 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. Constraints: pt-careplan-status-allowed
intent	?!SΣ	1..1	code	(USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Slices for category	SΣ	1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: Pain treatment plan (required)
category:AssessPlan	SΣ	1..1	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: CarePlanCategory (preferred): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: assess-plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(QICore Patient)	(QI-Core)(USCDI) Who the care plan is for.
created	SΣ	1..1	dateTime	Date record was first recorded
author	SΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CarePlan.text.status	required	NarrativeStatus http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG
CarePlan.category:AssessPlan	preferred	Pattern Value: assess-plan http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'
txt-1	error	CarePlan.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	CarePlan.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

Differential View

This structure is derived from QICoreCarePlan

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
status	C	1..1	code	(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Constraints: pt-careplan-status-allowed
category		1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: Pain treatment plan (required)
created	S	1..1	dateTime	Date record was first recorded
author	S	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	QICoreCarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	S	0..1	Narrative	(USCDI) Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
status	S	1..1	code	(USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
div	SC	1..1	xhtml	(USCDI) Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan)	Fulfills CarePlan
replaces	Σ	0..*	Reference(CarePlan)	CarePlan replaced by this CarePlan
partOf	Σ	0..*	Reference(CarePlan)	Part of referenced CarePlan
status	?!SΣC	1..1	code	(USCDI) 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. Constraints: pt-careplan-status-allowed
intent	?!SΣ	1..1	code	(USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Slices for category	SΣ	1..*	CodeableConcept	(QI-Core)(USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: Pain treatment plan (required)
category:AssessPlan	SΣ	1..1	CodeableConcept	(QI-Core)(USCDI) Type of plan Binding: CarePlanCategory (preferred): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: assess-plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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(QICore Patient)	(QI-Core)(USCDI) Who the care plan is for.
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Time period plan covers
created	SΣ	1..1	dateTime	Date record was first recorded
author	SΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
contributor		0..*	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who provided the content of the care plan
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
supportingInfo		0..*	Reference(Resource)	Information considered as part of plan
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	0..*	BackboneElement	Action to occur as part of plan Constraints: cpl-3
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	C	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.
instantiatesCanonical		0..*	canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..*	uri	Instantiates external protocol or definition
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 (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
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 / Code	URI
CarePlan.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CarePlan.text.status	required	NarrativeStatus http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard
CarePlan.category	required	PAIN_TREATMENT_PLAN http://fhir.org/guides/cdc/opioid-cds/ValueSet/pain-treatment-plan From this IG
CarePlan.category:AssessPlan	preferred	Pattern Value: assess-plan http://hl7.org/fhir/ValueSet/care-plan-category 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	example	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()
pt-careplan-status-allowed	error	CarePlan.status	status must be active, completed, or stopped. : $this = 'active' or $this = 'completed'
txt-1	error	CarePlan.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	CarePlan.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from QICoreCarePlan

Summary

Mandatory: 1 element
Must-Support: 2 elements

Maturity: 2

Other representations of profile: CSV, Excel, Schematron