Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

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

Resource Profile: ManaakiNgaTahiCarePlan - Detailed Descriptions

Active as of 2025-04-11

Definitions for the ManaakiNgaTahiCarePlan resource profile.

Guidance on how to interpret the contents of this table can be found here

0. CarePlan
Definition

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

ShortHealthcare plan for patient or group
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesCare Team
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CarePlan.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CarePlan.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..01
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. CarePlan.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeGoalResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. CarePlan.modifierExtension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensionExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. CarePlan.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

ShortInstantiates FHIR protocol or definition
Control0..*
Typecanonical(PlanDefinition, Questionnaire, Measure, ActivityDefinition, OperationDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. CarePlan.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

ShortInstantiates external protocol or definition
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Control0..0*
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. CarePlan.basedOn
Definition

A care plan that is fulfilled in whole or in part by this care plan.

ShortFulfills CarePlan
Control0..0*
TypeReference(CarePlan)
Is Modifierfalse
Summarytrue
Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. CarePlan.replaces
Definition

Completed or terminated care plan whose function is taken by this new care plan.

ShortCarePlan replaced by this CarePlan
Comments

The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.

Control0..0*
TypeReference(CarePlan)
Is Modifierfalse
Summarytrue
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Alternate Namessupersedes
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. CarePlan.partOf
Definition

A larger care plan of which this particular care plan is a component or step.

ShortPart of referenced CarePlan
Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Control0..0*
TypeReference(CarePlan)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. CarePlan.status
Definition

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
Comments

The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.

This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.

Control1..1
BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/request-status|4.0.1)

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows clinicians to determine whether the plan is actionable or not.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. CarePlan.intent
Definition

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Shortproposal | plan | order | option
Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Control1..1
BindingThe codes SHALL be taken from CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
(required to http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1)

Codes indicating the degree of authority/intentionality associated with a care plan.

Typecode
Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request"
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. CarePlan.category
Definition

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

ShortType of plan
Comments

There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

Control0..*
BindingThe codes SHALL be taken from For example codes, see CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category
(required to http://hl7.org/fhir/ValueSet/care-plan-category)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Used for filtering what plan(s) are retrieved and displayed to different types of users.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. CarePlan.subject
Definition

Identifies the patient or group whose intended care is described by the plan.

ShortWho the care plan is for
Control1..1
TypeReference(Patient, Group)
Is Modifierfalse
Summarytrue
Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. CarePlan.period
Definition

Indicates when the plan did (or is intended to) come into effect and end.

ShortStart | end values must be in UTC timezone on the FHIR serverTime period plan covers
Comments

Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).

Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

Allows tracking what plan(s) are in effect at a particular time.

Alternate Namestiming
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. CarePlan.author
Definition

When populated, the author is responsible for the care plan. The care plan is attributed to the author.

ShortWho is the designated responsible party
Comments

The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.

Control0..1
TypeReference(Practitioner, Patient, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. CarePlan.contributor
Definition

Identifies the individual(s) or organization who provided the contents of the care plan.

ShortWho provided the content of the care plan
Comments

Collaborative care plans may have multiple contributors.

Control0..0*
TypeReference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. CarePlan.supportingInfo
Definition

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

ShortInformation considered as part of plan
Comments

Use "concern" to identify specific conditions addressed by the care plan.

Control0..0*
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Requirements

Identifies barriers and other considerations associated with the care plan.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))