Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCarePlan | Version: 0.1.3 | |||
| Active as of 2025-06-05 | Computable Name: ManaakiNgaTahiCarePlan | |||
CarePlan FHIR resource for Manaaki Nga Tahi
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
 contained |
0..* | Goal | Contained, inline Resources | |
 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) |
 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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()) |
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Constraints: cpl-3 |
 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 | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| contained |
0..* | Goal | Contained, inline Resources | |
| 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) |
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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()) |
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Constraints: cpl-3 |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard |
| 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
Other representations of profile: CSV, Excel, Schematron