Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Outpatient Communication CarePlan

A care coordination profile that manages patient questionnaires and communication outcomes. Tracks CommunicationRequest references and QuestionnaireResponse outcomes within a care plan. Maintains activity status and performer information for clinician workflow tracking.

Usages:

• Refer to this Profile: Outpatient Communication Task
• Examples for this Profile: CarePlan/OutpatientCommunicationCarePlanExample
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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..*	CarePlan	Healthcare plan for patient or group
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
subject	SΣ	1..1	Reference(NZ Patient)	Patient reference with NHI
activity	C	0..*	BackboneElement	Action to occur as part of plan Constraints: cpl-3
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeReference		0..*	Reference(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
reference	C	0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
detail	C	0..1	BackboneElement	In-line definition of activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	?!S	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 Binding: Outpatient Activity Status Reason (preferred)
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
performer		0..*	Reference(Practitioner | PractitionerRole)	Clinician who reviewed or acted on this activity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 From the FHIR Standard
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
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.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CarePlan	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
partOf		0..0
category		0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
subject	S	1..1	Reference(NZ Patient)	Patient reference with NHI
period		0..0
created		0..0
contributor		0..0
careTeam		0..0
addresses		0..0
supportingInfo		0..0
goal		0..0
activity
outcomeReference		0..*	Reference(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
reference		0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
detail
status	S	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
statusReason		0..1	CodeableConcept	Reason for current status Binding: Outpatient Activity Status Reason (preferred)
performer		0..*	Reference(Practitioner | PractitionerRole)	Clinician who reviewed or acted on this activity
note		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
CarePlan.activity.detail.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	SΣ	1..1	Reference(NZ Patient)	Patient reference with NHI
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
author	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
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(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
progress		0..*	Annotation	Comments about the activity status/progress
reference	C	0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
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	?!S	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 Binding: Outpatient Activity Status Reason (preferred)
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)	Clinician who reviewed or acted on this activity
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
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	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 From the FHIR Standard
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
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.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CarePlan	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CarePlan

Summary

Mandatory: 6 elements
Must-Support: 2 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• CMS Communication (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication)
• CMS Communication Request (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest)
• Outpatient Communication Task (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutpatientCommunicationTask)

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
subject	SΣ	1..1	Reference(NZ Patient)	Patient reference with NHI
activity	C	0..*	BackboneElement	Action to occur as part of plan Constraints: cpl-3
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
outcomeReference		0..*	Reference(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
reference	C	0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
detail	C	0..1	BackboneElement	In-line definition of activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	?!S	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 Binding: Outpatient Activity Status Reason (preferred)
doNotPerform	?!	0..1	boolean	If true, activity is prohibiting action
performer		0..*	Reference(Practitioner | PractitionerRole)	Clinician who reviewed or acted on this activity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CarePlan.intent	required	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 From the FHIR Standard
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
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.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CarePlan	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
partOf		0..0
category		0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
subject	S	1..1	Reference(NZ Patient)	Patient reference with NHI
period		0..0
created		0..0
contributor		0..0
careTeam		0..0
addresses		0..0
supportingInfo		0..0
goal		0..0
activity
outcomeReference		0..*	Reference(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
reference		0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
detail
status	S	1..1	code	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
statusReason		0..1	CodeableConcept	Reason for current status Binding: Outpatient Activity Status Reason (preferred)
performer		0..*	Reference(Practitioner | PractitionerRole)	Clinician who reviewed or acted on this activity
note		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
CarePlan.activity.detail.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intent	?!Σ	1..1	code	proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
category	Σ	0..*	CodeableConcept	Outpatient service category or specialty Binding: Outpatient Service Codes (preferred)
title	Σ	0..1	string	Human-friendly name for the care plan
description	Σ	0..1	string	Summary of nature of plan
subject	SΣ	1..1	Reference(NZ Patient)	Patient reference with NHI
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
author	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)	Who is the designated responsible party
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(QuestionnaireResponse | CMS Communication)	QuestionnaireResponse or Communication outcome reference
progress		0..*	Annotation	Comments about the activity status/progress
reference	C	0..1	Reference(CMS Communication Request | Outpatient Communication Task)	CommunicationRequest reference
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	?!S	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 Binding: Outpatient Activity Status Reason (preferred)
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)	Clinician who reviewed or acted on this activity
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CarePlan.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
CarePlan.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
CarePlan.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
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	CarePlanIntent http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 From the FHIR Standard
CarePlan.category	preferred	OutpatientCategoriesVS(a valid code from Outpatient Service Codes) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-categories-vs From this IG
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.statusReason	preferred	OutpatientActivityStatusReasonVS(a valid code from Outpatient Activity Status Reason) https://fhir-ig.digital.health.nz/shared-care/ValueSet/outpatient-activity-status-reason-vs From this IG
CarePlan.activity.detail.product[x]	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpl-3	error	CarePlan.activity	Provide a reference or detail, not both : detail.empty() or reference.empty()
dom-2	error	CarePlan	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CarePlan	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	CarePlan	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CarePlan	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CarePlan

Summary

Mandatory: 6 elements
Must-Support: 2 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• CMS Communication (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication)
• CMS Communication Request (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest)
• Outpatient Communication Task (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutpatientCommunicationTask)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron