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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

NDH Outpatients

The Dunedin Hospital digital programme is implementing a number of integrations between various third party products used within the outpatient function as defined in the solution architecture.

These include but are not limited to interfaces between the following Group 4 solutions:

  • Cardiobase – Southern district Cardiology information system
  • Karisma – Southern district Radiology information system
  • Pinga - Clinic Room Scheduling by SORSIX; a cloud-based platform that manages clinic room bookings and associates clinic sessions with rooms
  • PQMS - Patient Queue Management System by Five Faces; a cloud-based platform that streamlines patient readiness for care, self-check-in, patient engagement and optimizes patient flow. From the pre-arrival process, through to post-appointment, patients are supported and offered personalized information and updates regarding their appointment.
  • SIPICS – South Island Patient Administration System (PAS) by McCrae Tech (formerly Orion Health)

The original design developed with NTT used Southern Rhapsody as the main integration method between group 4 systems.

Subsequently, a decision was made and endorsed by the NDH DSDA to adopt a FHIR integration approach using the national integration capabilities, MuleSoft, National Event Management Service (NEMS) and AWS FHIR Works.

However, it was determined that some systems only supported a single outbound path and that in order to support legacy requirements, it would be necessary to continue to use some legacy Rhapsody routes until such time as those systems could be fully migrated to FHIR RESTful interfaces (which were beyond the scope of this work).

Where possible, a standards-based collection of FHIR APIs are implemented to expose Patient, Appointment, and associated FHIR resources from the relevant systems.

A limited set of update APIs enable Patient and Appointment updates to the source systems and vendors will enhance the capabilities of their systems to consume these.

Patient Queue Management System (PQMS)

1. Get Patient
2. Update Patient
3. Get Appointment
4. Update Appointment

Get Patient

The following shows the expected interactions for getting patient data for PQMS.

Get Patient (FHIR REST API)Get Patient (FHIR REST API)MiddlewarePQMSAPIMiddlewareSIPICSPQMSPatient QueueManagement SystemPQMSPatient QueueManagement SystemAPIGatewayAPIGatewayMiddlewareIntegrationPlatformMiddlewareIntegrationPlatformSIPICSPatient AdministrationSystem (PAS)SIPICSPatient AdministrationSystem (PAS)Middleware[01]FHIR APIGet Patient[02]FHIR RoutedGet Patient[03]Mapping FHIR to SIPICS API[04]Retrieve Patient via API[05]Response[06]Mapping SIPICS API to FHIR[07]FHIR Patient Resource[08]FHIR RoutedPatient Resource


Update Patient

The following shows the expected interactions for updating patient data from PQMS.

Update Patient (FHIR REST API)Update Patient (FHIR REST API)MiddlewarePQMSAPIMiddlewareSIPICSPQMSPatient QueueManagement SystemPQMSPatient QueueManagement SystemAPIGatewayAPIGatewayMiddlewareIntegrationPlatformMiddlewareIntegrationPlatformSIPICSPatient AdministrationSystem (PAS)SIPICSPatient AdministrationSystem (PAS)Middleware[01]FHIR APIUpdate Patient[02]FHIR RoutedUpdate Patient[03]Mapping FHIR to SIPICS API[04]Update Patient via API[05]Response[06]Mapping SIPICS API response to FHIR[07]FHIR Patient Resource[08]FHIR RoutedPatient Resource


Get Appointment

The following shows the expected interactions for getting appointment data for PQMS.

Get Appointment (FHIR REST API)Get Appointment (FHIR REST API)MiddlewarePQMSAPIMiddlewareFHIR CDRPQMSPatient QueueManagement SystemPQMSPatient QueueManagement SystemAPIGatewayAPIGatewayMiddlewareIntegrationPlatformMiddlewareIntegrationPlatformFHIR CDRAWS FHIRWorksFHIR CDRAWS FHIRWorksMiddleware[01]FHIR APIGet Appointment[02]FHIR RoutedGet Appointment[03]Retrieve Appointment via FHIR API[04]FHIR Response[05]FHIR Appointment Resource[06]FHIR RoutedAppointment Resource


Update Appointment

The following shows the expected interactions for updating appointment data from PQMS.

Update Appointment (FHIR REST API)Update Appointment (FHIR REST API)MiddlewarePQMSAPIMiddlewareSIPICSCardiobaseFHIRFHIR CDRNEMSPQMSPatient QueueManagement SystemPQMSPatient QueueManagement SystemAPIGatewayAPIGatewayMiddlewareIntegrationPlatformMiddlewareIntegrationPlatformSIPICSPatientAdministrationSystem (PAS)SIPICSPatientAdministrationSystem (PAS)CardiobaseCardiologyInformationSystemCardiobaseCardiologyInformationSystemFHIRConverterServiceFHIRConverterServiceFHIR CDRFHIR CDRNEMSNational EventManagement ServiceNEMSNational EventManagement ServiceMiddleware[01]FHIR APIUpdate Appointment[02]FHIR RoutedUpdate Appointmentalt[Destination SIPICS][03]Mapping FHIR to SIPICS API[04]Appointment statusupdate via SIPICS API[05]AppointmentsHL7 v2 SIU/ADT[06]FHIR updates[07]Response[08]Response[09]Mapping SIPICSresponse to FHIR[Destination Cardiobase][10]Mapping FHIR to HL7v2[11]Appointment Statusupdate HL7v2 ORM[12]AppointmentsHL7 v2 SIU/ADT[13]FHIR updates[14]Response[15]Response[16]Mapping Cardiobaseresponse to FHIR[17]FHIR Success[18]FHIR RoutedPatient Resource[19]Update eventtrigger[20]Update event