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

Remote Patient Monitoring

Remote Patient Monitoring

The Remote Patient Monitoring initiative is an initiative the seeks to deliver care to patients in Remote parts of the country, leveraging a Patient facing App and Consumer Technology to record patient wellbeing, with a clinician being able to monitor and provide advice to these patients from afar using the Provider View.

Remote Patient Monitoring in FHIR

Data Structure

CarePlan Activities CarePlan Context Resources Captured Data CommunicationRequestsubject : Reference to Patient Tasksubject : Reference to PatientrelevantHistory : Reference to Provenancecode : CodeableConcept ("educational content") ServiceRequestsubject : Reference to Patient Conditionsubject : Reference to Patientperformer : Reference to Practitionercode : CodeableConcept (TBD)category : CodeableConcept (TBD) Encounterperiod_start : datetimeperiod_end : datetimediagnosis_condition_reference : Reference to Conditionstatus : string ("in-progress", "finished", etc.)class_code : CodeableConcept (e.g. VR = virtual)serviceType_code : CodeableConcept (e.g. 554 = Chronic Disease Management)priority_code : CodeableConcept (e.g. R = routine)subject : Reference to Patient (with identifier and display)participant : Reference to Practitioner (identifier + display)reasonCode : CodeableConcept (e.g. patient-initiated encounter)serviceProvider : Reference to Organization (identifier + display) CareTeammeta_versionId : stringmeta_profile[] : stringidentifier_use : stringidentifier_system : stringidentifier_value : stringparticipant_member_identifier_use : stringparticipant_member_identifier_system : stringparticipant_member_identifier_value : stringparticipant_member_display : stringmanagingOrganization_identifier_value : stringmanagingOrganization_identifier_use : stringmanagingOrganization_identifier_system : stringmanagingOrganization_display : stringstatus : string ("active", etc.)name : string ("Remote Monitoring CareTeam")participant_member_type : string ("Practitioner")managingOrganization_type : string ("Organization") Provenancesubject : Reference to PatientextensionCode : TBD Observationsubject : Reference to PatientbasedOn : Reference to CarePlan QuestionnaireResponsesubject : Reference to PatientbasedOn : Reference to CarePlan Consentsubject : Reference to PatientperiodoptionalprovisionData : Reference[] CarePlanmeta_profile : "RPM CarePlan"subject : Reference to Patientcondition : Reference to Conditionactivity : Reference[] addresses.reference encounter.reference careTeam.reference activity.reference activity.reference activity.reference relevantHistory basedOn basedOn


Patient Onboarding

The Remote Patient Monitoring Flows and Experience for any given Patient are centered around their CarePlan. At the time of a Patients commencement in the RPM programme this CarePlan along with a series of related resources are created.

AdminPractitionerPractitioner ViewShared Care FHIR ServerQueueCommon Messaging ServicePatientAlphero AppEducation Content BucketAdminPractitionerAdminPractitionerPractitioner ViewPractitioner ViewShared Care FHIR ServerShared Care FHIR ServerQueueQueueCommon Messaging ServiceCommon Messaging ServicePatientPatientAlphero AppAlphero AppEducation Content BucketEducation Content BucketPatient OnboardingInital EncounterPOST ConditionPOST EncounterPOST CareTeamPOST TaskPOST ConsentCreate CarePlanSearch Plan DefinitionsApply Plan Definition, with patient, practitioner, and encounterPOST CarePlanPUT Consent, attaching CarePlanAdd Service RequestsSearch Activity DefinitionsApply Action Definition, with patient, practitioner, and CarePlanPOST Service RequestPUT Consent, attaching Service RequestPUT CarePlan, attaching Service RequestPatient Notification via CMSPOST CommunicationRequestHandle incoming Communication RequestPOST CommunicationRequest (via Subscription)Send EmailPOST Communication (inidcating email sent)


Data Gathering

Throughout the period of care, Questionnaires are used to gather clinical insights into the Patients wellbeing and experience, along with feedback surrounding the quality of experience surrounding the Piki Te Ora App.

Observations are generated via a Series of Smart Devices, that interact with the Piki App, that are then posted to the Shared Care API.

AdminPractitionerPractitioner ViewShared Care FHIR ServerQueueCommon Messaging ServicePatientAlphero AppEducation Content BucketAdminPractitionerAdminPractitionerPractitioner ViewPractitioner ViewShared Care FHIR ServerShared Care FHIR ServerQueueQueueCommon Messaging ServiceCommon Messaging ServicePatientPatientAlphero AppAlphero AppEducation Content BucketEducation Content BucketRoutine Questionnaire Response CollectionOpens AppFetches relevant QuestionnaireRender QuestionnaireCompletes QuestionnairePOST QuestionnaireResponsePUT Consent


Educational Content

Patient on certain CarePlans may be assigned educational content to engage with: a series of short modules. A task attached to the CarePlan prescribes this education. Upon a modules completion within the app, a Provenance resource is created and attached to the Task as a relevantHistory.reference.

Option One: This flow uses a single Tasks resource per Patient and CarePlan. This tasks represents the completion of all educational content associated with the Careplan type. Upon Completion of a module, the Piki Te Ora App will POST a provenance resource, which encodes the completion of the module. These can be read by Provider view to display educational progress.

AdminPractitionerPractitioner ViewShared Care FHIR ServerQueueCommon Messaging ServicePatientAlphero AppEducation Content BucketAdminPractitionerAdminPractitionerPractitioner ViewPractitioner ViewShared Care FHIR ServerShared Care FHIR ServerQueueQueueCommon Messaging ServiceCommon Messaging ServicePatientPatientAlphero AppAlphero AppEducation Content BucketEducation Content BucketPatient OnboardingPOST CarePlan and Associated resources (Including Task)Educational Content ConsumptionOpens App, Selects and Consumes Education ContentFetches Education ContentRender ContentCompletes ModulePOST Provenance Resource (indicating completion)PUT Task (add reference to Provenance)Complete Feedback QuestionnairePOST QuestionnaireResponse (completed)Provider View RenderingGET CareplanGET Provenance?basedOn=Careplan/example&subject=nhi&profile=rpmEducation


Option Two: This flow uses a pyramid of many Tasks resource per Patient and CarePlan. A single task represent a the entire syllabus, under which many subjects will represent the groups. Underneath this each group will have many tasks, each representing a module. Upon Completion of a module, the Piki Te Ora App will GET and PUT a task resource, updating its status to complete. These can be read by Provider view to display educational progress.

Practitioner ViewShared Care FHIR ServerPiki te OraPatientEducation Content BucketPractitioner ViewPractitioner ViewShared Care FHIR ServerShared Care FHIR ServerPiki te OraPiki te OraPatientPatientEducation Content BucketEducation Content BucketPatient OnboardingPOST CarePlan and Associated resourcesPOST Top Level TaskPOST Group Level TasksPOST Module Level TasksPUT Careplan (attatching tasks)Educational Content ConsumptionOpens App, Selects and Consumes Education ContentFetches Education ContentRender ContentCompletes ModuleGET Task?code=exampleModulecode&owner=nhi&profile=rpmEducationTaskPUT Task (setting task.status to completed)Complete Feedback QuestionnairePOST QuestionnaireResponse (completed)Provider View RenderingGET CareplanGET Task?basedOn=Careplan/example&owner=nhi&profile=rpmEducationTask


CarePlan: Education Planid = "careplan-education"status = "active"intent = "plan"description = "Care plan defining the patient's educational syllabus"Task: Educational Syllabusid = "task-syllabus"status = "requested"intent = "plan"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "SYLLABUS","display": "Educational Syllabus" }description = "Overall educational syllabus for patient"Task: Group 1id = "task-group-1"status = "requested"intent = "plan"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "GROUP-1","display": "Education Group 1" }description = "Group 1 - Introductory Modules"Task: Group 2id = "task-group-2"status = "requested"intent = "plan"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "GROUP-2","display": "Education Group 2" }description = "Group 2 - Advanced Modules"Task: Module 1.1id = "task-module-1-1"status = "requested"intent = "order"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "MODULE-1-1","display": "Module 1.1" }description = "Module 1.1 - Generic Module"Task: Module 1.2id = "task-module-1-2"status = "requested"intent = "order"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "MODULE-1-2","display": "Module 1.2" }description = "Module 1.2 - Generic Module"Task: Module 2.1id = "task-module-2-1"status = "requested"intent = "order"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "MODULE-2-1","display": "Module 2.1" }description = "Module 2.1 - Generic Module"Task: Module 2.2id = "task-module-2-2"status = "requested"intent = "order"code = { "system": "https://fhir.your-org.nz/CodeSystem/education-modules","code": "MODULE-2-2","display": "Module 2.2" }description = "Module 2.2 - Generic Module" basedOn basedOn basedOn basedOn basedOn basedOn basedOn