Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
NZ
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
NZ
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutpatientCommunicationCarePlan | Version: 0.4.5 | |||
| Active as of 2026-05-19 | Computable Name: OutpatientCommunicationCarePlan | |||
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:
You can also check for usages in the FHIR IG Statistics
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 | |
  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 |
SΣ | 0..* | CodeableConcept | Care plan category or specialty Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
 subject |
SΣ | 1..1 | Reference(NZ Patient) | Patient reference with NHI |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) |
 activity |
SC | 1..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeReference |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference |
| reference |
SC | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference |
| detail |
SC | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| instantiatesCanonical |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup |
| status |
?!S | 1..1 | code | Processing status flag Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care Activity Status Reason (preferred) |
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action |
 performer |
S | 0..* | Reference(Practitioner | PractitionerRole) | Clinician who reviewed or acted on this activity |
| 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 | example | 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 | |
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG |
| 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: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
 instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| partOf |
0..0 | |||
| category |
S | 0..* | CodeableConcept | Care plan category or specialty |
| title |
0..0 | |||
| description |
0..0 | |||
| subject |
S | 1..1 | Reference(NZ Patient) | Patient reference with NHI |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) |
| period |
0..0 | |||
| created |
0..0 | |||
| author |
0..0 | |||
| contributor |
0..0 | |||
| careTeam |
0..0 | |||
| addresses |
0..0 | |||
| supportingInfo |
0..0 | |||
| goal |
0..0 | |||
 activity |
S | 1..* | BackboneElement | Action to occur as part of plan |
 outcomeReference |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference |
| reference |
S | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference |
| detail |
S | 0..1 | BackboneElement | In-line definition of activity |
| instantiatesCanonical |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup |
| status |
S | 1..1 | code | Processing status flag |
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care Activity Status Reason (preferred) |
| performer |
S | 0..* | Reference(Practitioner | PractitionerRole) | Clinician who reviewed or acted on this activity |
| note |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG |
| 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 | ||||
| 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.
| |||||
| 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 |
SΣ | 0..* | CodeableConcept | Care plan category or specialty Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
| subject |
SΣ | 1..1 | Reference(NZ Patient) | Patient reference with NHI | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) | ||||
| activity |
SC | 1..* | 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 |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference | ||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
SC | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference | ||||
| detail |
SC | 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 |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup | ||||
| 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 | Processing status flag Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care 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 |
S | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| 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 | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesFrom 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 | |
| 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 |
SΣ | 0..* | CodeableConcept | Care plan category or specialty Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
| subject |
SΣ | 1..1 | Reference(NZ Patient) | Patient reference with NHI |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) |
| activity |
SC | 1..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeReference |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference |
| reference |
SC | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference |
| detail |
SC | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| instantiatesCanonical |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup |
| status |
?!S | 1..1 | code | Processing status flag Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care Activity Status Reason (preferred) |
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action |
| performer |
S | 0..* | Reference(Practitioner | PractitionerRole) | Clinician who reviewed or acted on this activity |
| 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 | example | 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 | |
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG |
| 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: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| partOf |
0..0 | |||
| category |
S | 0..* | CodeableConcept | Care plan category or specialty |
| title |
0..0 | |||
| description |
0..0 | |||
| subject |
S | 1..1 | Reference(NZ Patient) | Patient reference with NHI |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) |
| period |
0..0 | |||
| created |
0..0 | |||
| author |
0..0 | |||
| contributor |
0..0 | |||
| careTeam |
0..0 | |||
| addresses |
0..0 | |||
| supportingInfo |
0..0 | |||
| goal |
0..0 | |||
| activity |
S | 1..* | BackboneElement | Action to occur as part of plan |
| outcomeReference |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference |
| reference |
S | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference |
| detail |
S | 0..1 | BackboneElement | In-line definition of activity |
| instantiatesCanonical |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup |
| status |
S | 1..1 | code | Processing status flag |
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care Activity Status Reason (preferred) |
| performer |
S | 0..* | Reference(Practitioner | PractitionerRole) | Clinician who reviewed or acted on this activity |
| note |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG |
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 | ||||
| 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.
| |||||
| 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 |
SΣ | 0..* | CodeableConcept | Care plan category or specialty Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
| subject |
SΣ | 1..1 | Reference(NZ Patient) | Patient reference with NHI | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter or Referral Reference (logical reference) | ||||
| activity |
SC | 1..* | 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 |
S | 0..* | Reference(QuestionnaireResponse | Communication) | QuestionnaireResponse or Communication outcome reference | ||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
SC | 0..1 | Reference(CommunicationRequest) | CommunicationRequest reference | ||||
| detail |
SC | 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 |
S | 0..1 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | FHIR Questionnaire identifier for response lookup | ||||
| 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 | Processing status flag Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
| statusReason |
S | 0..1 | CodeableConcept | Detailed status reason for clinician workflow Binding: Shared Care 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 |
S | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| 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 | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryFrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.statusReason | preferred | SharedCareActivityStatusReasonVS(a valid code from Shared Care Activity Status Reason)https://fhir-ig.digital.health.nz/shared-care/ValueSet/shared-care-activity-status-reasonFrom this IG | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesFrom 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