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

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ManaakiNgaTahiCarePlan

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiCarePlan Version: 0.1.3
Active as of 2024-03-22 Computable Name: ManaakiNgaTahiCarePlan

CarePlan FHIR resource for Manaaki Nga Tahi

Usage:

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... implicitRules 0..0
... language 0..0
... contained 0..*GoalContained, inline Resources
... instantiatesCanonical 0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... partOf 0..0
... category 0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... subject 1..1Reference(Patient)Who the care plan is for
... period C0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author 0..1Reference(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..1TimingWhen activity is to occur
..... location 0..0
..... performer 0..0
..... product[x] 0..0
..... dailyAmount 0..0
..... quantity 0..0
..... description 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... contained 0..*GoalContained, inline Resources
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... subject Σ1..1Reference(Patient)Who the care plan is for
... period ΣC0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author Σ0..1Reference(Practitioner)Who is the designated responsible party

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period ΣC0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(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 C0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... detail C0..1BackboneElementIn-line definition of activity
..... extension 0..*ExtensionAdditional content defined by implementations
..... instantiatesCanonical 0..*canonical(Questionnaire)Instantiates FHIR protocol or definition
..... status ?!1..1codenot-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..1TimingWhen activity is to occur
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from CarePlan

Summary

Prohibited: 31 elements

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... implicitRules 0..0
... language 0..0
... contained 0..*GoalContained, inline Resources
... instantiatesCanonical 0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... partOf 0..0
... category 0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... subject 1..1Reference(Patient)Who the care plan is for
... period C0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author 0..1Reference(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..1TimingWhen activity is to occur
..... location 0..0
..... performer 0..0
..... product[x] 0..0
..... dailyAmount 0..0
..... quantity 0..0
..... description 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... contained 0..*GoalContained, inline Resources
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... subject Σ1..1Reference(Patient)Who the care plan is for
... period ΣC0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author Σ0..1Reference(Practitioner)Who is the designated responsible party

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (required)
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period ΣC0..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(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 C0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... detail C0..1BackboneElementIn-line definition of activity
..... extension 0..*ExtensionAdditional content defined by implementations
..... instantiatesCanonical 0..*canonical(Questionnaire)Instantiates FHIR protocol or definition
..... status ?!1..1codenot-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..1TimingWhen activity is to occur
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from CarePlan

Summary

Prohibited: 31 elements

 

Other representations of profile: CSV, Excel, Schematron