haau3 CarePlan - haau3 FHIR Implementation Guide (HFIG) v1.0.0

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

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

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

(USCDI) generated | extensions | additional | empty
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.

div

1..1

xhtml

(USCDI) Limited xhtml content
Constraints: txt-1, txt-2

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored

identifier

1..*

Identifier

External Ids for this plan

0..*

canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)

Instantiates FHIR protocol or definition

0..*

Instantiates external protocol or definition

0..*

Fulfills CarePlan

0..*

CarePlan replaced by this CarePlan

partOf

0..*

Reference(CarePlan)

Part of referenced CarePlan

1..1

intent

1..1

(USCDI) proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

Slices for category

1..*

(USCDI) Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

category:AssessPlan

1..1

(USCDI) Type of plan
Binding: CarePlanCategory (example): 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

Unique id for inter-element referencing

0..*

Additional content defined by implementations

coding

1..*

Coding

Code defined by a terminology system
Fixed Value: (Complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

system

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category

version

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: assess-plan

display

0..1

Representation defined by the system

userSelected

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

title

0..1

Human-friendly name for the care plan

0..1

Reference(US Core Patient Profile)

Summary of nature of plan

subject

1..1

(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

0..1

dateTime

Date record was first recorded

author

0..1

Who is the designated responsible party

contributor

0..*

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..*

Information considered as part of plan

0..*

Desired outcome of plan

activity

0..*

Action to occur as part of plan
Constraints: cpl-3

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

outcomeCodeableConcept

0..*

Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.

outcomeReference

0..*

Appointment, Encounter, Procedure, etc.

progress

0..*

Comments about the activity status/progress

reference

0..1

Activity details defined in specific resource

detail

0..1

In-line definition of activity

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

kind

0..1

0..*

canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)

Instantiates FHIR protocol or definition

0..*

Instantiates external protocol or definition

0..1

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..*

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

0..*

Goals this activity relates to

1..1

statusReason

0..1

Reason for current status

doNotPerform

0..1

If true, activity is prohibiting action

scheduled[x]

0..1

When activity is to occur

scheduledTiming

scheduledPeriod

scheduledString

0..1

Where it should happen

performer

0..*

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

productReference

Reference(Medication | Substance)

dailyAmount

0..1

How to consume/day?
Constraints: sqty-1

quantity

0..1

How much to administer/supply/consume
Constraints: sqty-1

0..1

Extra info describing activity to perform

note

0..*

Documentation for this format

Comments about the plan

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CarePlan.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
CarePlan.text.status	Base	required	US Core Narrative Status	📦6.1.0	US Core v6.1
CarePlan.status	Base	required	RequestStatus	📦4.0.1	FHIR Std.
CarePlan.intent	Base	required	Care Plan Intent	📦4.0.1	FHIR Std.
CarePlan.category	Base	example	Care Plan Category	📦4.0.1	FHIR Std.
CarePlan.category:AssessPlan	Base	example	Care Plan Category	📦4.0.1	FHIR Std.
CarePlan.activity.outcomeCodeableConcept	Base	example	Care Plan Activity Outcome	📦4.0.1	FHIR Std.
CarePlan.activity.detail.kind	Base	required	Care Plan Activity Kind	📍4.0.1	FHIR Std.
CarePlan.activity.detail.code	Base	example	Procedure Codes (SNOMED CT)	📦4.0.1	FHIR Std.
CarePlan.activity.detail.reasonCode	Base	example	SNOMED CT Clinical Findings	📦4.0.1	FHIR Std.
CarePlan.activity.detail.status	Base	required	CarePlanActivityStatus	📍4.0.1	FHIR Std.
CarePlan.activity.detail.product[x]	Base	example	SNOMED CT Medication Codes	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()`
sqty-1	error	CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity	The comparator is not used on a SimpleQuantity	`comparator.empty()`
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 USCoreCarePlanProfile

Summary

Mandatory: 1 element
Must-Support: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
CarePlan		0..*	USCoreCarePlanProfile(6.1.0)	Healthcare plan for patient or group
CarePlan.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
CarePlan.text	This element must be supported.	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
CarePlan.text.status	This element must be supported.	1..1	code	(USCDI) generated \| extensions \| additional \| empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
CarePlan.text.div	This element must be supported. C	1..1	xhtml	(USCDI) Limited xhtml content Constraints: txt-1, txt-2
CarePlan.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
CarePlan.identifier	This element must be supported. This element is included in summaries.	1..*	Identifier	External Ids for this plan
CarePlan.status	This element is a modifier element. This element must be supported. This element is included in summaries.	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.
CarePlan.intent	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	code	(USCDI) proposal \| plan \| order \| option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
CarePlan.Slices for category	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	(USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:AssessPlan	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	(USCDI) Type of plan Binding: CarePlanCategory (example): 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
CarePlan.Slices for category.category:AssessPlan.id		0..1	string	Unique id for inter-element referencing
CarePlan.Slices for category.category:AssessPlan.extension		0..*	Extension	Additional content defined by implementations
CarePlan.Slices for category.category:AssessPlan.coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
CarePlan.Slices for category.category:AssessPlan.coding.id		0..1	string	Unique id for inter-element referencing
CarePlan.Slices for category.category:AssessPlan.coding.extension		0..*	Extension	Additional content defined by implementations
CarePlan.Slices for category.category:AssessPlan.coding.system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
CarePlan.Slices for category.category:AssessPlan.coding.version		0..1	string	Version of the system - if relevant
CarePlan.Slices for category.category:AssessPlan.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: assess-plan
CarePlan.Slices for category.category:AssessPlan.coding.display		0..1	string	Representation defined by the system
CarePlan.Slices for category.category:AssessPlan.coding.userSelected		0..1	boolean	If this coding was chosen directly by the user
CarePlan.Slices for category.category:AssessPlan.text		0..1	string	Plain text representation of the concept
CarePlan.subject	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) Who the care plan is for
CarePlan.activity	This element must be supported. C	0..*	BackboneElement	Action to occur as part of plan Constraints: cpl-3
CarePlan.activity.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CarePlan.text.status	Base	required	US Core Narrative Status	📦6.1.0	US Core v6.1
CarePlan.status	Base	required	RequestStatus	📦4.0.1	FHIR Std.
CarePlan.intent	Base	required	Care Plan Intent	📦4.0.1	FHIR Std.
CarePlan.category	Base	example	Care Plan Category	📦4.0.1	FHIR Std.
CarePlan.category:AssessPlan	Base	example	Care Plan Category	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()`
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 USCoreCarePlanProfile

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
CarePlan		0..*	USCoreCarePlanProfile(6.1.0)	Healthcare plan for patient or group
CarePlan.identifier	This element must be supported.	1..*	Identifier	External Ids for this plan
CarePlan.activity	This element must be supported.	0..*	BackboneElement	Action to occur as part of plan
Documentation for this format

Snapshot View

Description & Constraints Filter:

CarePlan

0..*

USCoreCarePlanProfile(6.1.0)

Healthcare plan for patient or group

id

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

0..1

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

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

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

1..1

(USCDI) generated | extensions | additional | empty
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.

div

1..1

xhtml

(USCDI) Limited xhtml content
Constraints: txt-1, txt-2

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored

identifier

1..*

Identifier

External Ids for this plan

0..*

canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)

Instantiates FHIR protocol or definition

0..*

Instantiates external protocol or definition

0..*

Fulfills CarePlan

0..*

CarePlan replaced by this CarePlan

partOf

0..*

Reference(CarePlan)

Part of referenced CarePlan

1..1

intent

1..1

(USCDI) proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

Slices for category

1..*

(USCDI) Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

category:AssessPlan

1..1

(USCDI) Type of plan
Binding: CarePlanCategory (example): 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

Unique id for inter-element referencing

0..*

Additional content defined by implementations

coding

1..*

Coding

Code defined by a terminology system
Fixed Value: (Complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

system

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category

version

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: assess-plan

display

0..1

Representation defined by the system

userSelected

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

title

0..1

Human-friendly name for the care plan

0..1

Reference(US Core Patient Profile)

Summary of nature of plan

subject

1..1

(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

0..1

dateTime

Date record was first recorded

author

0..1

Who is the designated responsible party

contributor

0..*

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..*

Information considered as part of plan

0..*

Desired outcome of plan

activity

0..*

Action to occur as part of plan
Constraints: cpl-3

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

outcomeCodeableConcept

0..*

Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.

outcomeReference

0..*

Appointment, Encounter, Procedure, etc.

progress

0..*

Comments about the activity status/progress

reference

0..1

Activity details defined in specific resource

detail

0..1

In-line definition of activity

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

kind

0..1

0..*

canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)

Instantiates FHIR protocol or definition

0..*

Instantiates external protocol or definition

0..1

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..*

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

0..*

Goals this activity relates to

1..1

statusReason

0..1

Reason for current status

doNotPerform

0..1

If true, activity is prohibiting action

scheduled[x]

0..1

When activity is to occur

scheduledTiming

scheduledPeriod

scheduledString

0..1

Where it should happen

performer

0..*

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

productReference

Reference(Medication | Substance)

dailyAmount

0..1

How to consume/day?
Constraints: sqty-1

quantity

0..1

How much to administer/supply/consume
Constraints: sqty-1

0..1

Extra info describing activity to perform

note

0..*