Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) 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: ManaakiNgaTahiCarePlan

CarePlan FHIR resource for Manaaki Nga Tahi

Usage:

• Examples for this Resource Profile: CarePlan/CarePlanExample
• CapabilityStatements using this Resource Profile: Shared Care FHIR Server Capability Statement

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
CarePlan		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
contained		0..*	Goal	Contained, inline Resources
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition 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
category	Σ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	Who the care plan is for ele-1: All FHIR elements must have a @value or children
period	Σ	0..1	Period	Start | end values must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
author	Σ	0..1	Reference(Practitioner)	Who is the designated responsible party ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
implicitRules		0..0
language		0..0
contained		0..*	Goal	Contained, inline Resources
modifierExtension		0..0
instantiatesCanonical		0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
partOf		0..0
category		0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (required)
subject		1..1	Reference(Patient)	Who the care plan is for
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
author		0..1	Reference(Practitioner)	Who is the designated responsible party
contributor		0..0
supportingInfo		0..0
activity
id		0..0
extension		0..0
modifierExtension		0..0
outcomeCodeableConcept		0..0
progress		0..0
reference		0..0
detail
id		0..0
modifierExtension		0..0
kind		0..0
instantiatesCanonical		0..*	canonical(Questionnaire)	Instantiates FHIR protocol or definition
instantiatesUri		0..0
code		0..0
reasonCode		0..0
reasonReference		0..0
goal		0..0
statusReason		0..0
doNotPerform		0..0
scheduled[x]		0..1	Timing	When activity is to occur
location		0..0
performer		0..0
product[x]		0..0
dailyAmount		0..0
quantity		0..0
description		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Goal	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
identifier	Σ	0..*	Identifier	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition
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	Type of plan Binding: CarePlanCategory (required)
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)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Start | end values must be in UTC timezone on the FHIR server
created	Σ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Practitioner)	Who is the designated responsible party
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
detail	C	0..1	BackboneElement	In-line definition of activity
extension		0..*	Extension	Additional content defined by implementations
instantiatesCanonical		0..*	canonical(Questionnaire)	Instantiates FHIR protocol or definition
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.
scheduled[x]		0..1	Timing	When activity is to occur
note		0..*	Annotation	Comments about the plan
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category 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

This structure is derived from CarePlan

Summary

Prohibited: 31 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CarePlan		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
contained		0..*	Goal	Contained, inline Resources
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition 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
category	Σ	0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	Who the care plan is for ele-1: All FHIR elements must have a @value or children
period	Σ	0..1	Period	Start | end values must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
author	Σ	0..1	Reference(Practitioner)	Who is the designated responsible party ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

Differential View

This structure is derived from CarePlan

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
implicitRules		0..0
language		0..0
contained		0..*	Goal	Contained, inline Resources
modifierExtension		0..0
instantiatesCanonical		0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
partOf		0..0
category		0..*	CodeableConcept	Type of plan Binding: CarePlanCategory (required)
subject		1..1	Reference(Patient)	Who the care plan is for
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
author		0..1	Reference(Practitioner)	Who is the designated responsible party
contributor		0..0
supportingInfo		0..0
activity
id		0..0
extension		0..0
modifierExtension		0..0
outcomeCodeableConcept		0..0
progress		0..0
reference		0..0
detail
id		0..0
modifierExtension		0..0
kind		0..0
instantiatesCanonical		0..*	canonical(Questionnaire)	Instantiates FHIR protocol or definition
instantiatesUri		0..0
code		0..0
reasonCode		0..0
reasonReference		0..0
goal		0..0
statusReason		0..0
doNotPerform		0..0
scheduled[x]		0..1	Timing	When activity is to occur
location		0..0
performer		0..0
product[x]		0..0
dailyAmount		0..0
quantity		0..0
description		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CarePlan.category	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CarePlan		0..*	CarePlan	Healthcare plan for patient or group
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Goal	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
identifier	Σ	0..*	Identifier	External Ids for this plan
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition)	Instantiates FHIR protocol or definition
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	Type of plan Binding: CarePlanCategory (required)
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)	Who the care plan is for
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
period	Σ	0..1	Period	Start | end values must be in UTC timezone on the FHIR server
created	Σ	0..1	dateTime	Date record was first recorded
author	Σ	0..1	Reference(Practitioner)	Who is the designated responsible party
careTeam		0..*	Reference(CareTeam)	Who's involved in plan?
addresses	Σ	0..*	Reference(Condition)	Health issues this plan addresses
goal		0..*	Reference(Goal)	Desired outcome of plan
activity	C	0..*	BackboneElement	Action to occur as part of plan cpl-3: Provide a reference or detail, not both
outcomeReference		0..*	Reference(Resource)	Appointment, Encounter, Procedure, etc.
detail	C	0..1	BackboneElement	In-line definition of activity
extension		0..*	Extension	Additional content defined by implementations
instantiatesCanonical		0..*	canonical(Questionnaire)	Instantiates FHIR protocol or definition
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.
scheduled[x]		0..1	Timing	When activity is to occur
note		0..*	Annotation	Comments about the plan
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	required	CarePlanCategory http://hl7.org/fhir/ValueSet/care-plan-category 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

This structure is derived from CarePlan

Summary

Prohibited: 31 elements

Other representations of profile: CSV, Excel, Schematron