Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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/OperationDefinition/DHOAppointmentBackfill | Version: 0.4.7 | |||
| Active as of 2026-10-13 | Computable Name: DHOAppointmentBackfill | |||
Starts a backfill of DHO Appointments in FHIR CDR and returns straight away with a job id. The run carries on in the background. Follow it with $backfill-status and stop it with $backfill-cancel.
Select Appointments with one of:
lastUpdated (updated on or after it) or apptDate (starting on or after it, or from apptDate to
apptDateTo inclusive)identifier values (SIPICS, legacy or Karisma SO appointment ids)Modes:
location-correction corrects each Appointment's location from SIPICS, or cancels it. Identifiers FHIR CDR
doesn't have are created from SIPICS.patient-instruction replaces each Appointment's patientInstruction from SIPICS.touch re-saves each Appointment unchanged, so its meta.lastUpdated moves on.URL: [base]/Appointment/$backfill
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | mode | 1..1 | code | location-correction, patient-instruction or touch | ||
| IN | lastUpdated | 0..1 | date | Select Appointments updated on or after this date. Not with apptDate or identifier. | ||
| IN | apptDate | 0..1 | date | Select Appointments starting on or after this date. Not with lastUpdated or identifier. | ||
| IN | apptDateTo | 0..1 | date | With apptDate: select Appointments starting from apptDate to this date, both included. | ||
| IN | identifier | 0..* | string | An appointment id value to select, under any appointment-id system. Not with a date. | ||
| IN | audit | 0..1 | boolean | true: look everything up and report what would change, but write nothing. Not for touch. | ||
| OUT | job | 1..1 | string | The job id, for $backfill-status and $backfill-cancel | ||
| OUT | status | 1..1 | code | accepted |