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

Careplan Workflow

CarePlan Workflow

This page describes the workflow for creating and managing CarePlans with questionnaire responses and communication tracking.

Sequence Diagram

The following diagram shows the complete workflow from CarePlan creation through patient response:

Client ApplicationIntegration ServicesExternalHCSHCSFHIR APIFHIR APIMagicLinkMagicLinkCMSCMSPatientPatientHCSHCSFHIR APIFHIR APIMagicLinkMagicLinkCMSCMSPatientPatient1. CarePlan Creation & Magic Link[01]POST CarePlan[02]201 Created (CarePlan ID)[03]Generate Magic Link (inc. CarePlan ID)[04]201 URL/Token2. Communication Request[05]«Bundle»POST CommunicationRequestPUT CarePlanCarePlan update includesref to CommunicationRequest[06]200 OK (BundleResponse)3. Patient Notification[07]CommunicationRequest Notification[08]Send SMS/Email[09]«Bundle»POST CommunicationPUT CarePlanUpdate CarePlan withref to Communication[10]200 OK (BundleResponse)[11]PUT CommunicationRequest (status=completed)[12]200 Updated4. Patient ResponsePatient follows Magic Link[13]Submits Questionnaire[14]«Bundle»POST QuestionnaireResponsePUT CarePlanUpdate CarePlan withref to QuestionnaireResponse[15]200 OK (BundleResponse)5. Client Retrieval[16]GET CarePlan?_id=[ID]&_include=CarePlan:activity:reference&_include=CarePlan:activity:outcomeReference&_include=CarePlan:activity:detail:instantiatesCanonicalIncludes:CommunicationRequest (reference)QuestionnaireResponse (outcomeReference)Communication (outcomeReference)Questionnaire (instantiatesCanonical)[17]200 OK (Bundle: SearchSet)Contains CarePlan +all linked resourcesin a single response.

Key Components

CarePlan Profile

​The NdhCarePlan profile supports:

  • Patient reference with NHI
  • Encounter/referral references
  • Communication tracking
  • Questionnaire management with magic links
  • Processing status flags

Workflow Steps

  1. CarePlan Creation: Client creates a CarePlan with patient and questionnaire details
  2. Magic Link Generation: System generates a secure link for patient access
  3. Communication Request: CommunicationRequest is created and linked to the CarePlan
  4. Patient Notification: CMS sends notification to patient with magic link
  5. Patient Response: Patient completes questionnaire via magic link
  6. Data Retrieval: Client retrieves updated CarePlan with all references

Integration Points

  • FHIR API: Core resource management
  • MagicLink Service: Secure patient access to questionnaires
  • CMS: Communication and notification management
  • Client Applications: Care coordination and monitoring