ACT-NOW Implementation Guide, published by Te aho o te kahu - Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/actnow/ and changes regularly. See the Directory of published versions

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

Resource Profile: Regimen Careplan

A CarePlan that represents a PlanDefinition being applied to a Patient. Referred to as a regimen. The regimen has multiple cycles also represented as CarePlans which have a 'partOf' reference back to the regimen plan.

Usage:

• Refer to this Resource Profile: Cycle Careplan
• Examples for this Resource Profile: CarePlan/careplan-regimen-1 and CarePlan/careplan-regimen-2

Formal Views of Profile Content

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

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

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan	C	0..*	CarePlan	Healthcare plan for patient or group an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required)
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required)
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number
identifier		1..*	Identifier	External Ids for this plan
intent		1..1	code	proposal | plan | order | option Required Pattern: plan
category		1..*	CodeableConcept	Type of plan
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code
coding:regimencode	S	1..1	Coding	Regimen level carePlan
system		0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Required Pattern: 261751000210101
period	C	1..1	Period	Time period plan covers an-period-1: The end date of a period must be greater than or equal to the start date
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()

Name	Flags	Card.	Type	Description & Constraints
CarePlan	C	0..*	CarePlan	Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..*	Identifier	External Ids for this plan ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children Required Pattern: plan
category	Σ	1..*	CodeableConcept	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. ele-1: All FHIR elements must have a @value or children
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code ele-1: All FHIR elements must have a @value or children
coding:regimencode	SΣ	1..1	Coding	Regimen level carePlan ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: 261751000210101
subject	Σ	1..1	Reference(Patient | Group)	Who the care plan is for ele-1: All FHIR elements must have a @value or children
period	ΣC	1..1	Period	Time period plan covers ele-1: All FHIR elements must have a @value or children an-period-1: The end date of a period must be greater than or equal to the start date
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	Pattern: plan http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	example	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()
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	C	0..*	CarePlan	Healthcare plan for patient or group an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
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		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required)
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required)
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	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	?!Σ	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. Required Pattern: plan
category	Σ	1..*	CodeableConcept	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code
coding:regimencode	SΣ	1..1	Coding	Regimen level carePlan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: 261751000210101
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	Σ	1..1	Reference(Patient | Group)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	ΣC	1..1	Period	Time period plan covers an-period-1: The end date of a period must be greater than or equal to the start date
created	Σ	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
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 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	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.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	Pattern: plan http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	example	CarePlanCategory 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
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()
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: 8 elements
Must-Support: 7 elements

Extensions

This structure refers to these extensions:

• http://canshare.co.nz/fhir/StructureDefinition/an-iot
• http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
• http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
• http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
• http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
• http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
• http://canshare.co.nz/fhir/StructureDefinition/an-course-number

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CarePlan.category.coding

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan	C	0..*	CarePlan	Healthcare plan for patient or group an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required)
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required)
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number
identifier		1..*	Identifier	External Ids for this plan
intent		1..1	code	proposal | plan | order | option Required Pattern: plan
category		1..*	CodeableConcept	Type of plan
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code
coding:regimencode	S	1..1	Coding	Regimen level carePlan
system		0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Required Pattern: 261751000210101
period	C	1..1	Period	Time period plan covers an-period-1: The end date of a period must be greater than or equal to the start date
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CarePlan	C	0..*	CarePlan	Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..*	Identifier	External Ids for this plan ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children Required Pattern: plan
category	Σ	1..*	CodeableConcept	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. ele-1: All FHIR elements must have a @value or children
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code ele-1: All FHIR elements must have a @value or children
coding:regimencode	SΣ	1..1	Coding	Regimen level carePlan ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: 261751000210101
subject	Σ	1..1	Reference(Patient | Group)	Who the care plan is for ele-1: All FHIR elements must have a @value or children
period	ΣC	1..1	Period	Time period plan covers ele-1: All FHIR elements must have a @value or children an-period-1: The end date of a period must be greater than or equal to the start date
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	Pattern: plan http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	example	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()
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	C	0..*	CarePlan	Healthcare plan for patient or group an-regimenCP-1: If the CarePlan was cancelled, then the cancellation reason extension must be present
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		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
intent-of-treatment		0..1	CodeableConcept	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-iot Binding: Intent of treatment (required)
clinical-trial	S	0..1	boolean	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
cycle-count	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
regimen-discontinued	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
overall-treatment-utility	S	0..1	(Complex)	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
regimen-type	S	1..1	CodeableConcept	Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code (required)
course-number	S	0..1	integer	Extension URL: http://canshare.co.nz/fhir/StructureDefinition/an-course-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	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	?!Σ	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. Required Pattern: plan
category	Σ	1..*	CodeableConcept	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:code
coding:regimencode	SΣ	1..1	Coding	Regimen level carePlan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: 261751000210101
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	Σ	1..1	Reference(Patient | Group)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	ΣC	1..1	Period	Time period plan covers an-period-1: The end date of a period must be greater than or equal to the start date
created	Σ	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
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 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	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.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CarePlan.intent	required	Pattern: plan http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard
CarePlan.category	example	CarePlanCategory 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
an-period-1	error	CarePlan.period	The end date of a period must be greater than or equal to the start date : Period.end >= Period.start
an-regimenCP-1	error	CarePlan	If the CarePlan was cancelled, then the cancellation reason extension must be present : CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()
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: 8 elements
Must-Support: 7 elements

Extensions

This structure refers to these extensions:

• http://canshare.co.nz/fhir/StructureDefinition/an-iot
• http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial
• http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count
• http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued
• http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu
• http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
• http://canshare.co.nz/fhir/StructureDefinition/an-course-number

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CarePlan.category.coding

Other representations of profile: CSV, Excel, Schematron